doc: update commit documentation to better represent intent
This commit is contained in:
parent
4c6037f72a
commit
ef938639c7
10
README.md
10
README.md
|
@ -13,14 +13,14 @@
|
||||||
### Git Commits
|
### Git Commits
|
||||||
|
|
||||||
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 function, use this
|
- `feat`: features, if any part of your commit implements a new functionality, use this
|
||||||
- `fix`: bugfixes
|
- `fix`: bugfixes
|
||||||
- `doc`: documentation
|
|
||||||
- `refactor`: code refactoring
|
- `refactor`: code refactoring
|
||||||
- `config`: changing configuration (linter, build process)
|
- `update`: updating dependencies and associated code changes
|
||||||
- `update`: updating dependencies and associated changes
|
- `doc`: documentation
|
||||||
|
- `config`: changing configuration (linters, build process)
|
||||||
|
|
||||||
Always try to split up your changes into coherent commits, a single commit should do a single thing.
|
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.
|
||||||
|
|
||||||
### Database Migrations
|
### Database Migrations
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue