Commit message guidelines
Last updated
Last updated
Your contributions will be rejected if you won't follow this guideline.
We have very precise rules over how our git commit messages can be formatted.
We use the git commit messages to generate @exile-watch/{project} change logs via @exile-watch/conventional-changelog-config.
This also leads to more readable messages that are easy to follow when looking through the project history.
The commit contains the following structural elements, to communicate intent to the consumers of our libraries:
fix: a commit of the type fix
patches a bug in your codebase (this correlates with PATCH
in Semantic Versioning).
feat: a commit of the type feat
introduces a new feature to the codebase (this correlates with MINOR
in Semantic Versioning).
BREAKING CHANGE: a commit that appends a !
after the type/scope, introduces a breaking API change (correlating with MAJOR
in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
other types that are supported:
build:
chore:
ci:
docs:
style:
refactor:
perf:
test:
tl;dr: https://www.conventionalcommits.org/examples
!
to draw attention to breaking change