Be better programmer through better commits.
<type>(<optional scope>): <summary in present tence>
<optional body>
<optional footer>
Must be one of those:
- feat: new feature
- fix: bug fix
- perf: code change that improves performance
- refactor: change of code structure but not functionality
- style: code style change (whitespace, missing semicolon, etc.)
- test: adding missing test or fixing existing one
- chore: commit which does not affect the code, for example package update
- docs: change to documentation
Scope is application specific.
Examples of scope can be:
- app
- api
- router
- runner
- etc.
- feat(api): allow creation of foo with bar
- fix: prevent duplication of data
- perf: use for loop instead of forEach
- refactor: separate creation of record into creation and validation
- style: add missing semicolon
- test: add test for foo
- chore: bump version of x package
Use BREAKING CHANGE: <description>
footer to describe the breaking change or give information on
what has to be done.
Use !
after optional scope to bring attention to the change.
!
and BREAKING CHANGE
footer can be used together
chore(api)!: drop support for version X
BREAKING CHANGE: use functions only available after version X