changelog
Pronunciation: CHAYNJ-log
A curated document, typically accompanying a software release, that lists all notable changes, bug fixes, and new features introduced in each version.
Full Definition
A changelog (also written as CHANGELOG when referring to the file itself) is a chronological record that helps users and developers understand what has changed between versions of a software project. The widely adopted 'Keep a Changelog' convention specifies sections such as Added, Changed, Deprecated, Removed, Fixed, and Security. Editors should note the one-word, lowercase form for the document type in prose ('the project maintains a changelog'), whereas the filename is conventionally uppercase (CHANGELOG.md). Changelogs are distinct from commit logs or git history, which are raw and not curated for a non-developer audience.
Usage
Usage note: One word in prose: 'changelog'. The filename is uppercased (CHANGELOG.md). Distinguish from raw commit logs, which are unedited and not user-facing.
In Context
- "All breaking changes must be clearly marked in the changelog before a major release." — Release management policy
- "Refer to the changelog to determine which version introduced support for OAuth 2.0." — Upgrade guide