commit templatesCommit type templates
Format, examples, and best practices for every conventional commit type.
- featA commit that introduces new functionality visible to end users or downstream consumers of your API.
- fixA commit that corrects a defect: unintended behaviour, an error condition, or a regression that caused something to work incorrectly.
- refactorA commit that restructures existing code without changing its observable behaviour — no new features and no bug fixes.
- docsA commit that changes documentation only: README files, API docs, inline comments, or guides — no production code changes.
- testA commit that adds missing tests, corrects existing tests, or refactors the test suite — no production code changes.
- choreA commit for maintenance tasks that do not modify production source code or tests: dependency updates, tooling configuration, build scripts, and housekeeping.
- perfA commit that improves performance — reduces latency, memory use, or CPU consumption — without changing the observable behaviour of the software.
- styleA commit that makes purely cosmetic changes to code formatting with no effect on logic: whitespace, indentation, semicolons, trailing commas, or quote style.
- ciA commit that changes CI/CD pipeline configuration files and scripts: GitHub Actions, GitLab CI, CircleCI, Dockerfile, or deployment scripts.
- breaking-changeA commit that introduces an incompatible change to a public API, protocol, or behaviour that requires consumers to make corresponding changes.