Skip to content

Commit 069a2a2

Browse files
committed
docs(CONTRIBUTING.md): clarify commit types
1 parent fc5c941 commit 069a2a2

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

.github/CONTRIBUTING.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Closes #8454
2929
commit type / /
3030
\ | |
3131
feat(ngInclude): add template url parameter to events
32-
32+
3333
body -> The 'src` (i.e. the url of the template to load) is now provided to the
3434
`$includeContentRequested`, `$includeContentLoaded` and `$includeContentError`
3535
events.
@@ -39,21 +39,24 @@ Closes #8454
3939
```
4040

4141
For the commit type, use the matching type from this list:
42-
- feat
43-
- fix
44-
- docs
45-
- style
46-
- refactor
47-
- test
48-
- chore
42+
- **feat**: A new feature
43+
- **fix**: A bug fix
44+
- **docs**: Documentation only changes
45+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
46+
semi-colons, etc)
47+
- **refactor**: A code change that neither fixes a bug nor adds a feature
48+
- **perf**: A code change that improves performance
49+
- **test**: Adding missing tests
50+
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
51+
generation
4952

5053
### Summary
5154

5255
Please use __present tense__ inside your commit message at all time. Keywords like `add` `fix` and friends should be in __lower case__ to keep things consistent.
5356

5457
### Linking to github
5558

56-
Here as well, please make sure that you use the __present tense__ for `Closes` and `Fixes` and add `References #XX` before referencing a github issue if you are not closing it. Please write these keywords in __uppercase__.
59+
Here as well, please make sure that you use the __present tense__ for `Closes` and `Fixes` and add `References #XX` before referencing a github issue if you are not closing it. Please write these keywords in __uppercase__.
5760

5861
## Pull requests
5962
Pull requests are currently submitted to `master`. This might change in the future so please keep an eye on this.

0 commit comments

Comments
 (0)