diff --git a/README.md b/README.md index eee717c..e06dd77 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,14 @@ 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, use this +- `feat`: features, if any part of your commit implements a new functionality or changes an existing one, use this +- `remove`: removal of existing code/functionality - `fix`: bugfixes - `refactor`: code refactoring - `update`: updating dependencies and associated code changes - `config`: changing configuration (linters, build process) -- `reformat`: fixing code formatting - `doc`: documentation +- `reformat`: fixing code formatting 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.