The repository has adopted the following style of commits:
<type>(<scope>): <subject>
| <type>: <subject>
rr
If a commit contains Breaking Changes, use !
to show it:
<type>(<scope>)!: <subject>
| <type>!: <subject>
feat: add hat wobble
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Commit type.
feat
: A new feature. Correlates with MINOR in SemVerfix
: A bug fix. Correlates with PATCH in SemVerbuild
: Changes that affect the build system or external dependenciesci
: Changes to our CI configuration files and scriptsdocs
: Documentation only changesperf
: A code change which improves performancerefactor
: A code change that neither fixesrevert
: A revert to previous commitstyle
: Changes that do not affect the meaning of the code (white-space, formatting, etc).
Each release's Changelog is made up of commits that are either feat, fix or contain Breaking Changes, so you should be naming things carefully.