To help facilitate the automatic generation of changelogs, commit messages should be written using the Conventional Commits Standard,
<type>[(optional scope)]: <description>
[optional body]
[optional footer(s)]
Common types:
fix: bugfix (PATCH in SemVer)feat: feature (MINOR in SemVer)type!: breaking (MAJOR in SemVer) e.g.
feat!: totally cool breaking featurerevert, build, chore, ci, docs, style, refactor,
perf, testScopes meaning the area of code change applies to, e.g.
feat(api): delete trees route
fix(next-app): fixed that pesky flickering issue
refactor(ui): user model split into Myself & User
test(strapi)!: converts mocha & chai to Jest
Gotcha: The first character after the type must be lower-case!
Commit message with description and breaking change footer
feat: allow provided config object to extend other configs
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
Commit message with ! to draw attention to breaking change
refactor!: drop support for Node 6
Commit message with scope and ! to draw attention to breaking change
refactor(runtime)!: drop support for Node 6
Commit message with both ! and BREAKING CHANGE footer
refactor!: drop support for Node 6
BREAKING CHANGE: refactor to use JavaScript features not available in Node 6.
Commit message with no body
docs: correct spelling of CHANGELOG
Commit message with scope
feat(lang): add polish language
Commit message with multi-paragraph body and multiple footers
fix: prevent racing of requests
Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.
Remove timeouts which were used to mitigate the racing issue but are
obsolete now.
Reviewed-by: Z
Refs: #123