Important
use vscode-conventional-commits to easly make good commits
demo can be found at the end of the page
- most important: good commit message
- use prefixes
- write lowercase, reference pr's and do not add a dot at the end
why prefixes?
looks better and helps searchign commits faster
example commit message with prefix: fix: wrong api url
add "!" at the end if it's a breaking change (not backwards compatible): fix!: xxx
prefixes:
fix
: Bug fixfeat
: a new feature or enhancementchore
: updating dependencies or setting up build tools etcci
: change to CI like GitHub Actionsrefactor
: code refactoring without adding new features or fixing bugsdocs
: documentation-only changes (README etc)style
: changes related to formatting such as code style adjustments, and whitespace changes (not css changes)perf
: performance improvements without changing existing functionalitytest
: unit tests etcrevert
: revert a commit
scoped prefixes (optional):
fix(scope): xxx
fix(css): invisible button
feat(auth): add OAuth support
fix(api): handle null response error
docs(readme): update installation instructions
with the vscode-conventional-commits extension from above you can also easly add emojis (or just write 🚀 for example after the prefix).
fix(emoji): :rocket: emojis
all emojis can be found here