olivierlacan/keep-a-changelog resource

Health v2 · maintenance only

Adoption not part of the score

6679 stars · 3545 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded

Keep a Changelog is a specification and advocacy project that defines a standard, human-readable format for writing software changelogs in Markdown. The repository also generates the keepachangelog.com website, which documents the format and provides translations.

Use cases

• write a changelog for my open source project
• standardize release notes format across repos
• stop dumping git logs into changelogs
• learn how to structure a CHANGELOG.md file
• adopt semantic versioning alongside a changelog convention

When to choose

• you want a widely adopted, community-recognized changelog convention
• you need a template and guidelines for human-readable release notes
• you want to align changelogs with Semantic Versioning

When to avoid

• you need a tool that automatically generates changelogs from commits
• you want machine-parsed machine-readable release metadata rather than a prose convention

Facets

learning-resource · maturity active

documentation markdown version-control documentation developer-tools version-control cli changelog semantic-versioning release-notes specification static-site web-server

Member repositories

For agents

markdown · JSON · MCP: product_card(name="olivierlacan/keep-a-changelog")