Xymorot/RenaiApp
Xymorot
/
RenaiApp
1
1
Fork 0
Code Issues Pull Requests Releases Activity

meta: retire "doc" commit type (replaced by "meta")

This commit is contained in:
Xymorot 2020-01-05 14:00:21 +01:00
parent 07f117b752
commit d399628928
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -88,14 +88,21 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org) wi
| `update` | updating dependencies and associated code changes | | `update` | updating dependencies and associated code changes |
| `test` | any of the above, but with tests/mocks | | `test` | any of the above, but with tests/mocks |
| `config` | changing configuration (npm scripts, linters, build process) | | `config` | changing configuration (npm scripts, linters, build process) |
| `meta` | updating something not that is not function or documentation (e.g. design) | | `meta` | updating something not that is not function/testing (design, documentation, comments) |
| `doc` | updating documentation, including code comments |
| `reformat` | rewriting code in a way in which it is impossible for function to change | | `reformat` | rewriting code in a way in which it is impossible for function to change |
Always try to split up your changes into coherent commits, a single commit should do a single thing. If your commit needs to do more than one thing it should be labeled with the type coming first in this list. Always try to split up your changes into coherent commits, a single commit should do a single thing. If your commit needs to do more than one thing it should be labeled with the type coming first in this list.
Special cases are **merge commits** and **revert commits**. Git provides a default commit message for these two cases, just leave them if you do nothing else to the committed files. Special cases are **merge commits** and **revert commits**. Git provides a default commit message for these two cases, just leave them if you do nothing else to the committed files.
##### Retired Types
You might find the following types in the git history but their use is discouraged in favor of another type:
| type | description | replaced by |
| ----- | ----------------------------------------------- | ----------- |
| `doc` | updating documentation, including code comments | `meta` |
#### Git Hooks #### Git Hooks
This project uses [Husky](https://github.com/typicode/husky) to define git hooks. The point of the pre-commit hook is to have a clean commits. This means correctly formatted, without linter errors and functioning tests. The `npm run fix` script fixes all fixable errors, the tests you have to fix yourself. This project uses [Husky](https://github.com/typicode/husky) to define git hooks. The point of the pre-commit hook is to have a clean commits. This means correctly formatted, without linter errors and functioning tests. The `npm run fix` script fixes all fixable errors, the tests you have to fix yourself.