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

doc: display commit types in a table with some better explanations

This commit is contained in:
Xymorot 2019-11-20 23:29:58 +01:00
parent e79a94191e
commit 0101e02345
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -16,15 +16,17 @@
This project uses [Conventional Commits](https://www.conventionalcommits.or) with the following types: This project uses [Conventional Commits](https://www.conventionalcommits.or) with the following types:
- `feat`: features, if any part of your commit implements a new functionality or changes an existing one, use this | type | description |
- `remove`: removal of existing code/functionality | ---------- | --------------------------------------------------------------------------------------- |
- `fix`: bugfixes | `feat` | implementing a new feature or changes an existing one |
- `refactor`: code refactoring | `remove` | removing an existing feature |
- `update`: updating dependencies and associated code changes | `fix` | repairing a feature which does not work correctly |
- `test`: any of the above, but with tests/mocks | `refactor` | reworking code so that its function does not change (but could have in unexpected ways) |
- `config`: changing configuration (linters, build process) | `update` | updating dependencies and associated code changes |
- `doc`: documentation, including comments | `test` | any of the above, but with tests/mocks |
- `reformat`: fixing code formatting | `config` | changing configuration (npm scripts, linters, build process) |
| `doc` | updating documentation, including code comments |
| `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.