1.3 KiB
1.3 KiB
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 fixupdate
- for an enhancement or update not qualifying as a featurefeature
- for a new featureperf
- for a code change that improves performancerefactor
- for a code change that isn't one offix
,update
,feature
orperf
build
- for changes that affect the build system or external dependenciestest
- for adding or correcting testsstyle
- for changes to the linter or formatter configuration and its resultsdocs
- for changes to documentation onlyci
- for changes to the CI and its configurationother
- for anything that isn't covered by the tags above
If a change is a breaking change then that should be indicated by adding a !
after the tag.
These tags are an adapted version of the tags eslint and of the tags Angular use.
This commit message format is also inspired by Conventional Commits.