manifesto.md

Specificationv1.1.0Release Hygiene

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

  1. Changelogs are for humans, not machines.
  2. There should be an entry for every single version.
  3. The same types of changes should be grouped.
  4. Versions and sections should be linkable.
  5. The latest version comes first.
  6. The release date of each version is displayed.
  7. 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

Badge

manifesto.md: listed

[![manifesto.md](https://img.shields.io/endpoint?url=https://manifesto.md/badge/keep-a-changelog.json)](https://manifesto.md/keep-a-changelog/)

Maintainers claim a listing with a pull request setting listing: claimed, or a yes on the listing issue.