diff --git a/commit-types.md b/commit-types.md index 057dafbd..e64bf047 100644 --- a/commit-types.md +++ b/commit-types.md @@ -1,16 +1,22 @@ -# Commit types +# Conventional commit types For [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), -Evan uses the following types: +in addition to the default types - `fix`: patches a bug - `feat`: introduces a new feature to the codebase + +Evan uses the following types: + +- `build`: build related - `ci`: work related to CI - `chore`: updating deps, etc. -- `doc`: documentation changes +- `docs`: documentation changes - `drop`: deleting stuff or removing a feature -- `edit`: minor changes that aren't big enough to be considered a feature +- `edit`: minor changes that don't constitute a new feature +- `perf`: performance improvements - `polish`: copy editing or cleanup that doesn't affect functionality - `refactor`: major rewriting or restructuring that doesn't fix bugs or affect functionality +- `revert`: revert commits - `style`: code style changes -- `tests`: unit testing, etc. +- `test`: unit testing, etc.