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.
Canonical text: https://keepachangelog.com/en/1.1.0/, read against version 1.1.0. In use on this site: github.com/manifesto-md/manifesto.md/blob/main/CHANGELOG.md.
Guiding principles
- Changelogs are for humans, not machines.
- There should be an entry for every single version.
- The same types of changes should be grouped.
- Versions and sections should be linkable.
- The latest version comes first.
- The release date of each version is displayed.
- Mention whether you follow Semantic Versioning.
Facts
- Maintainer
- Olivier Lacan
- Repository
- https://github.com/olivierlacan/keep-a-changelog
- First published
- 2014
- 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.
-
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.
Badge
[](https://manifesto.md/keep-a-changelog/) Maintainers claim a listing with a pull request setting listing: claimed, or a yes on the listing issue.