meta: retire "config" commit type in favor of "meta"

This commit is contained in:
Xymorot 2020-02-09 00:42:33 +01:00
parent 00ebd0e5c8
commit ce453380cb
1 changed files with 6 additions and 6 deletions

View File

@ -86,9 +86,8 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org) wi
| `fix` | repairing a feature which does not work correctly | | `fix` | repairing a feature which does not work correctly |
| `refactor` | reworking code so that its function does not change (but could have in unexpected ways) | | `refactor` | reworking code so that its function does not change (but could have in unexpected ways) |
| `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 when it only applies to tests/mocks |
| `config` | changing configuration (npm scripts, linters, build process) | | `meta` | updating something not that is not directly related to function/tests |
| `meta` | updating something not that is not function/testing (design, documentation, 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.
@ -99,9 +98,10 @@ Special cases are **merge commits** and **revert commits**. Git provides a defau
You might find the following types in the git history but their use is discouraged in favor of another type: You might find the following types in the git history but their use is discouraged in favor of another type:
| type | description | replaced by | | type | description | replaced by |
| ----- | ----------------------------------------------- | ----------- | | -------- | ------------------------------------------------------------ | ----------- |
| `doc` | updating documentation, including code comments | `meta` | | `doc` | updating documentation, including code comments | `meta` |
| `config` | changing configuration (npm scripts, linters, build process) | `meta` |
#### Git Hooks #### Git Hooks