Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/hooks/commit-msg
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ if ! head -1 "$1" | grep -qE "^(build|chore|ci|docs|feat|fix|perf|refactor|rever
echo "For more information check https://www.conventionalcommits.org/en/v1.0.0/ for more details" >&2
exit 1
fi
if ! head -1 "$1" | grep -qE "^.{9,85}$"; then
echo "Aborting commit. Your commit message is too long. Max length is 89 characters" >&2
if ! head -1 "$1" | grep -qE "^.{9,72}$"; then
echo "Aborting commit. Your commit message is too long. Max length is 72 characters" >&2
exit 1
fi
fi
1 change: 1 addition & 0 deletions .github/workflows/markdown-link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ on:

jobs:
markdown-link-check:
name: "Markdown link check"
runs-on: ubuntu-latest

steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ env:
jobs:

test-project:
name: "Test nuget"
name: "Test project"
runs-on: ubuntu-22.04
permissions:
contents: read
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'NuGet vulnerabilites'
name: 'Vulnerability Check'


on:
Expand All @@ -16,8 +16,8 @@ on:

jobs:

sonar-scanner:
name: "NuGet vulnerabilites"
nuget-vulnerabilities-check:
name: "NuGet vulnerabilities"
runs-on: ubuntu-latest

steps:
Expand All @@ -35,7 +35,7 @@ jobs:
- name: "Build"
run: dotnet build --configuration Release --no-restore

- name: "Checking NuGet vulnerabilites"
- name: "Checking NuGet vulnerabilities"
run: |
dotnet list package --vulnerable --include-transitive 2>&1 | tee build.log
echo "Analyze dotnet list package command log output..."
Expand Down
23 changes: 11 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@ We would love for you to contribute to this project and help make it even better
As a contributor, here are the guidelines we would like you to follow. It does help everyone to accept your Pull Requests with maximum awesomeness:

- [Code of Conduct](#code-of-conduct)
- [General Seps](#general-seps)
- [Commits and Pull Requests](#commits-pr)
- [General Steps](#general-steps)
- [Commits and Pull Requests](#commits-and-pull-requests)
- [Conventional Commits](#conventional-commits)
- [Common types you can use](#commits-types)
- [Common types you can use (based on the Angular convention)](#common-types-you-can-use-based-on-the-angular-convention)
- [Coding Standards](#coding-standards)
- [Tests](#tests)



## <a name="code-of-conduct"></a> Code of Conduct
## <a name="code-of-conduct"></a>Code of Conduct

Please read and follow our [Code of Conduct][coc].



## <a name="general-seps"></a> General Seps
## <a name="general-steps"></a>General Steps

1. Check if there is already an open issue for the subject;
2. Open an issue to discuss the new feature;
Expand All @@ -31,14 +31,14 @@ Please read and follow our [Code of Conduct][coc].
8. Submit a pull request;


## <a name="commits-pr"></a> Commits and Pull Requests
## <a name="commits-pr"></a>Commits and Pull Requests

* :x: **AVOID** breaking the continuous integration build.
* :heavy_check_mark: **DO** atomic commits to make it easier to analyze changes.
* :heavy_check_mark: **DO** keep pull requests small so they can be easily reviewed.
* :heavy_check_mark: **DO** only commit with conventional commit patterns

### <a name="conventional-commits"></a> Conventional Commits
### <a name="conventional-commits"></a>Conventional Commits
To know more about conventional commits, visit [Conventional Commits](https://conventionalcommits.org/).

In general the pattern mostly looks like this:
Expand All @@ -63,7 +63,7 @@ fix(server): send cors headers
feat(blog): add comment section
```

#### <a name="commits-types"></a> Common types you can use (based on the Angular convention):
#### <a name="commits-types"></a>Common types you can use (based on the Angular convention)

- `feat:` A new feature
- `fix:` A bug fix
Expand All @@ -80,15 +80,15 @@ feat(blog): add comment section



## <a name="coding-standards"></a> Coding Standards
## <a name="coding-standards"></a>Coding Standards
* :heavy_check_mark: **DO** add XML comment documentation to new classes, methods or parameters.
* :heavy_check_mark: **DO** add a test class for each feature and a test method for each
* :heavy_check_mark: **DO** add a test class for each feature and a test method for each
* :heavy_check_mark: **DO** use language conventions to make code easy to understand quickly. See some tips here: [dofactory](https://www.dofactory.com/csharp-coding-standards);
* :heavy_check_mark: **CONSIDER** using SOLID patterns;



## <a name="tests"></a> Tests
## <a name="tests"></a>Tests
* :heavy_check_mark: **DO** add a unit test if your Pull Requests resolves an issue or adds features.
* :heavy_check_mark: **CONSIDER** using test patterns like "AAA" and "Given When Then";
* :heavy_check_mark: **DO** add a test class for each feature and a test method for each assertion;
Expand All @@ -98,4 +98,3 @@ feat(blog): add comment section
***Disclaimer***
- 1️⃣ Unit in Unit Test is not a method/function.
- 2️⃣ One assertion per test doesn't mean invoking the Assert method only once.
> by @gsferreira
Loading