CHANGELOG

What is a .changelog file?

Human-readable list of what's changed between versions — what was added, what got fixed, what broke, what got removed.

Safe format
Type Document
By Olivier Lacan (Keep a Changelog)
MIME text/plain

Drop any file to identify it

No upload. No signup. No sending your file halfway across the internet.
We tell you what it is, right here in your browser.

What is it

The CHANGELOG file (often CHANGELOG.md, sometimes HISTORY.md or NEWS.md) documents the project's version history in a form humans can read. Each release gets a heading with the version number and date, followed by a list of changes grouped by type: Added, Changed, Deprecated, Removed, Fixed, Security. When a user asks "what's new in v2.4?" or "why did this break after I upgraded?", the CHANGELOG is the answer.

The industry standard format is Keep a Changelog (keepachangelog.com), which defines those six change categories and a release-note structure. Combined with semantic versioning (semver.org), the CHANGELOG becomes a contract: a major version bump means breaking changes (look for Removed/Changed entries), a minor bump means new features (Added), and a patch bump means bug fixes only (Fixed). Following this discipline pays off when users automate dependency updates — they can read the CHANGELOG and decide whether the upgrade is safe.

Many projects automate CHANGELOG generation from commit messages using tools like conventional-commits, release-please, or semantic-release. The trade-off: automated changelogs are always up-to-date and include nothing accidentally, but they read like commit logs rather than release notes. Hand-written changelogs are friendlier and more curated but require discipline to maintain. The best projects use automation as a starting point and edit the result before each release for clarity.

Technical details
Full Name
Changelog
MIME Type
text/plain
Developer
Olivier Lacan (Keep a Changelog)
Magic Bytes
N/A
Safety
.changelog is a known, safe format.
What opens it
Any text editor
FREE All
GitHub (web)
FREE All

* Renders Markdown automatically

FAQ
What's the difference between a CHANGELOG and git log?
git log is every commit — implementation details, refactors, typo fixes. A CHANGELOG is curated for users — what's new, what's fixed, what broke. Tools like conventional-commits can generate a starter CHANGELOG from commits, but most projects edit the result for clarity before publishing.
Should the CHANGELOG include unreleased changes?
Yes — Keep a Changelog recommends an `[Unreleased]` section at the top where you accumulate changes during development. When you cut a release, rename the section to the version number and date, then start a fresh `[Unreleased]` section.
Related formats