commit 1f1a95855585c5bcd963a7604988ebdf94fbe507 Author: Julian Schacher Date: Fri May 14 13:17:52 2021 +0200 Docs: Specify commit message format Add initial `CONTRIBUTING.md` specifying the commit message format to use. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b1f357f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing + +## Commit Message Format + +The commit message format is as follows: + +``` +Tag: Short description + +Longer description here if necessary +``` + +The `Tag` should be one of the following: + +- `Fix` - for a bug fix. +- `Update` - for a backwards compatible enhancement. +- `Feature` - for a new feature. +- `Breaking` - for a backwards-incompatible enhancement or feature. +- `Perf` - for a code change that improves performance. +- `Refactor` - for a code change that neither fixes a bug nor adds a feature (nor is `Perf`). +- `Build` - for changes that affect the build system or external dependencies. +- `Test` - for adding or correcting tests. +- `Docs` - for changes to documentation only. +- `Other` - for anything that isn't covered by the tags above. + +Those tags are an adapted version of the tags eslint () and of the tags Angular () uses.