Skip to content

Commit c785b95

Browse files
committed
docs: fix formatting inconsistencies in contributing guidelines
1 parent ffd9ff3 commit c785b95

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
We would love for you to contribute to this project and help make it even better than it is today!
44
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:
55

6-
- [ Code of Conduct](#-code-of-conduct)
7-
- [ General Steps](#-general-steps)
8-
- [ Commits and Pull Requests](#-commits-and-pull-requests)
9-
- [ Conventional Commits](#-conventional-commits)
10-
- [ Common types you can use (based on the Angular convention):](#-common-types-you-can-use-based-on-the-angular-convention)
11-
- [ Coding Standards](#-coding-standards)
12-
- [ Tests](#-tests)
6+
- [Code of Conduct](#code-of-conduct)
7+
- [General Steps](#general-steps)
8+
- [Commits and Pull Requests](#commits-and-pull-requests)
9+
- [Conventional Commits](#conventional-commits)
10+
- [Common types you can use (based on the Angular convention)](#common-types-you-can-use-based-on-the-angular-convention)
11+
- [Coding Standards](#coding-standards)
12+
- [Tests](#tests)
1313

1414

1515

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

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

2020

2121

22-
## <a name="general-steps"></a> General Steps
22+
## <a name="general-steps"></a>General Steps
2323

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

3333

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

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

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

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

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

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

8181

8282

83-
## <a name="coding-standards"></a> Coding Standards
83+
## <a name="coding-standards"></a>Coding Standards
8484
* :heavy_check_mark: **DO** add XML comment documentation to new classes, methods or parameters.
8585
* :heavy_check_mark: **DO** add a test class for each feature and a test method for each
8686
* :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);
8787
* :heavy_check_mark: **CONSIDER** using SOLID patterns;
8888

8989

9090

91-
## <a name="tests"></a> Tests
91+
## <a name="tests"></a>Tests
9292
* :heavy_check_mark: **DO** add a unit test if your Pull Requests resolves an issue or adds features.
9393
* :heavy_check_mark: **CONSIDER** using test patterns like "AAA" and "Given When Then";
9494
* :heavy_check_mark: **DO** add a test class for each feature and a test method for each assertion;

0 commit comments

Comments
 (0)