github.com/verdaccio
1
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-02-21 07:29:37 +01:00
Code Releases Wiki Activity

docs: add commit guidelines

Browse Source
This commit is contained in:
Juan Picado @jotadeveloper 2017-10-18 21:53:40 +02:00 committed by juanpicado
parent e5a2c327f7
commit c44a79b27c
1 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@ -157,11 +157,35 @@ $ git status
# #
# modified: somefile.js # modified: somefile.js
# #
$ git commit -m "Corrects some defect, fixes #12345, refs #12346" $ git commit -m "fix: correct some defect, fixes #12345, refs #12346"
[t12345 0000000] Corrects some defect, fixes #12345, refs #12346 [t12345 0000000] fix: correct some defect, fixes #12345, refs #12346
1 file changed, 2 insertions(+), 2 deletions(-) 1 file changed, 2 insertions(+), 2 deletions(-)
``` ```
#### Git Commit Guidelines
We follow the [conventional commit messages](https://conventionalcommits.org/) convention in order to automate Changelog generation and auto semantic versioning based on commit messages.
* feat: A new feature
* fix: A bug fix
A commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
eg:
```
feat: xxxxxxxxxx
````
A commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
eg:
```
fix: xxxxxxxxxx
````
Commits types as `docs:`,`style:`,`refactor:`,`perf:`,`test:` and `chore:` are valid but has no effect on versioning, but, it would be great if you use them.
### 5. Rebase and Push Changes ### 5. Rebase and Push Changes
If you have been working on your contribution for a while, the upstream repository may have changed. You may want to If you have been working on your contribution for a while, the upstream repository may have changed. You may want to