Conventional Commits
A lightweight convention on top of commit messages, type, scope and description, that machines and people can read and that maps onto semantic versions.
Canonical text: https://www.conventionalcommits.org/en/v1.0.0/, read against version 1.0.0. In use on this site: github.com/manifesto-md/manifesto.md/commits/main.
The shape
- type(scope): description, then an optional body and footers.
- fix correlates with a patch, feat with a minor, a breaking change footer or an exclamation mark with a major.
- Types beyond fix and feat are allowed and recommended, such as build, chore, ci, docs, style, refactor, perf, test.
Facts
- Maintainer
- The Conventional Commits maintainers
- Repository
- https://github.com/conventional-commits/conventionalcommits.org
- Licence of the text
- CC BY 3.0
- First published
- 2019
- Status of the text
- stable
- Listing
- listed, not yet claimed
Read with
-
Semantic Versioning
A version number of the form major.minor.patch and the rules for when each part increments, so dependency declarations mean the same thing to everyone.
-
Keep a Changelog
A format for a changelog file that people can read, one entry per version, grouped by the kind of change, newest first.
Badge
[](https://manifesto.md/conventional-commits/) Maintainers claim a listing with a pull request setting listing: claimed, or a yes on the listing issue.