Write changelogs for humans.
Common Changelog is a style guide for changelogs, adapted from and a stricter subset of Keep a Changelog. It embraces the guiding principle of Keep a Changelog that changelogs must be written by humans and for humans, while recognizing that a clean changelog starts with a clean git history. Let them strengthen each other.
🚀 Too long didn't read? Here's an example.
Click to expand
A changelog is a file that contains a curated, ordered list of notable changes for each versioned release of a project. Its purpose is to make it easier for consumers (and to a lesser extent contributors) to see precisely what changes have been made between two releases.
The consumers of software are human beings who care about what's in the software. They must be able to quickly understand the impact of a release. Semantic Versioning helps as a signaling mechanism but is not enough by itself. When software changes, people want to know why and how.
- Changelogs are for humans.
- Communicate the impact of changes.
- Sort content by importance.
- Skip content that isn't important.
- Link each change to further information.
- Project is under version control (this document assumes git).
- Each released version has a corresponding git tag.
- Project adheres to Semantic Versioning.
Filename must be CHANGELOG.md. File content must be Markdown and start with a first-level heading:
# ChangelogSubsequent Markdown content must be zero or more releases, also referred to as changelog entries. Releases must be sorted latest-first according to Semantic Versioning rules, even if a release with a smaller version was published at a later time. This means that the semantically latest (and hence most important and frequently sought) release is at the top of the changelog. There must be an entry for every new stable release.
A release must start with second-level Markdown heading in the following format:
## VERSION - DATEWhere VERSION is a semver-valid version (without "v" prefix) matching a git tag (with optional "v" prefix). If the version is new then the changelog entry should be committed before creating the git tag. The DATE must be in the form of YYYY-MM-DD (ISO 8601). For example:
## 1.0.1 - 2019-08-24The version should link to further information. If the project is hosted on GitHub, link the version to a GitHub release that should contain the same content as the changelog entry, alongside useful GitHub features like assets and the compare view. Preferably use reference-style links to keep the unrendered Markdown form of the changelog readable.
Example
## [1.0.1] - 2019-08-24
### Fixed
- Prevent segmentation fault upon `close()`
## [1.0.0] - 2019-08-23
_Initial release._
[1.0.1]: https://github.com/owner/name/releases/tag/v1.0.1
[1.0.0]: https://github.com/owner/name/releases/tag/v1.0.0After the heading, a release must have Markdown content that is either:
- One or more change groups;
- A notice followed by zero or more change groups.
Change groups are only optional if a notice explains why there aren't any. No other content is permitted, because a changelog is not a blog or detailed upgrade guide. Those have other goals and concerns and must be kept separate from the changelog.
A release might have a separate upgrade guide or blog post that is considered essential reading. Other times a release may need to clarify its status, when it was yanked or contains zero changes.
For these purposes a notice must be used. This is a single-sentence paragraph with otherwise arbitrary Markdown content. Adding Markdown emphasis markers is recommended. For example (links omitted):
## [2.0.0] - 2020-07-23
_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._
### Removed
- **Breaking:** remove `write()` method from public API (`01e3a64`)Notices are also useful to describe first releases (that have no changes). For example:
## [1.0.0] - 2019-08-23
_First release._Use notices wisely, as they will be the first thing a reader sees at the expense of regularly structured content. There can only be one notice per release. If a notice pertains to code (rather than a release or associated artifacts) and has a suitable place outside of the changelog, write it there instead.
A change group must start with a third-level, text-only Markdown heading containing a category:
### <category>The category must be one of (in order):
Changedfor changes in existing functionalityAddedfor new functionalityRemovedfor removed functionalityFixedfor bug fixes.
The word functionality here can also mean documentation, supported runtime environments and so forth. The categories exist to easily recognize the impact of changes and to allow skimming a changelog. Changes that are listed under Removed will typically be breaking, while anything under Added is potentially interesting to the reader but carries no risk when upgrading.
The heading must be followed by (and only by) an unnumbered Markdown list. Each item in the list should be a single line that must start with a change, followed by one or more references and then zero or more authors. For example, if Alice and Henry fixed a bug together (links omitted for brevity):
- Prevent buffer overflow (#28) (Alice, Henry)
The list should be sorted: breaking changes first, then by other importance, then latest-first. The importance of a change is left to the writer's discretion.
Write a change using the imperative mood. It must start with a present-tense verb, for example (but not limited to) Add, Refactor, Bump, Document, Fix, Deprecate.
đź’ˇ It's highly recommended that git commits follow the same convention. A changelog draft can then be generated from git history without having to rephrase commit messages. Using the imperative mood tells someone what applying a commit will do. Similarly, in a changelog it tells someone what upgrading will do. It communicates an intent of change. Most importantly though, the choice of imperative mood is meant to increase consistency and avoid bike shedding.
Each change must be self-describing, as if no category heading exists. Instead of:
### Added
- Support of CentOS
- `write()` method
- Documentation for the `read()` methodWrite:
### Added
- Support CentOS
- Add `write()` method
- Document the `read()` methodA changelog is an alternative entrypoint to a codebase. It may be presented out-of-context in pull requests on third-party repositories, created by Dependabot or similar bots that read changelogs. Changes require context to understand and won't always be straightforward to describe, especially across language barriers.
For these reasons, changes must reference relevant commits, and should reference tickets or pull requests when available. Example:
- Fix infinite loop ([#194](https://github.com/owner/name/issues/194))References must be written after (and on the same line as) a change, so that content on that line is sorted by importance from left to right. References must be wrapped in parentheses. References of the same type may be separated by commas and only then wrapped in parentheses: (#1, #2) rather than (#1) (#2). Each reference must be a Markdown link.
When there are more than two available references, only include the best starting point for people that wish to learn more. For example, if a change happened in a pull request that closed a ticket, prefer to reference the pull request and not the ticket.
References can be written in one of the following forms.
Commits
([`53bd922`](https://github.com/owner/name/commit/53bd922))
([`owner/name@53bd922`](https://github.com/owner/name/commit/53bd922))The latter form should only be used for git submodules. If subsystem prefixes are used (see below) then the former short form is sufficient.
Pull Requests or issues
([#194](https://github.com/owner/name/issues/194))
([owner/name#194](https://github.com/owner/name/issues/194))The latter form should only be used to reference issues in external repositories. This can be useful for cross-repository efforts where a single issue is used to track progress or to explain a common change in detail.
External tickets
([JIRA-837](https://example.atlassian.net/browse/JIRA-837))Author names must be written after references, wrapped in parentheses and separated by commas. If the project only has one contributor, author names can be omitted. For changes authored by bots, the author listed in the changelog should be the person that merged the relevant Pull Request(s).
Example:
- Fix infinite loop ([#194](https://github.com/owner/name/issues/194)) (Alice Meerkat)There are no rules for whether to use the author's full name, username, or other. Common Changelog does recommend using the author's own preferred name, for which git is the most readily available source of truth.
Breaking changes must be prefixed in bold with **Breaking:** and should be listed before other changes (per category). For example (references omitted for brevity):
### Changed
- **Breaking:** emit `close` event after `end`
- Refactor `sort()` internals to improve performance
### Removed
- **Breaking:** drop support of Node.js 8For projects that contain subsystems (git submodules or other units of code) a change may be prefixed in bold with the name of that subsystem. It then also helps to sort changes by subsystem. A breaking change in a subsystem should be prefixed like so: **<subsystem> (breaking):** . For example:
- **Installer (breaking):** enable silent mode by default
- **UI**: tune button colors for accessibilityâś‹ The use of subsystems should generally be avoided as it weakens semver signaling.
Common Changelog has no opinions on Markdown formatting. The Markdown examples in this document follow the hallmark style guide.
🚧 I personally use
hallmark cc addto generate the initial content of a new changelog entry. However, it comes with opinions about Markdown formatting that are out of scope for Common Changelog. That said, I do consider it an essential tool in my workflow and intend to make it less opinionated, time permitting.
Exclude maintenance changes that are not interesting to consumers of the project (in its distributed form). To name a few:
- Dotfile changes (
.gitignore,.github,.gitlaband so forth) - Changes to development-only dependencies
- Minor code style changes
- Formatting changes in documentation.
However, changes such as the following must not be excluded:
- Refactorings, which may have unintentional side effects. Let the community review them.
- Changes to supported runtime environments (which may be reflected only in dotfiles)
- Code style changes that use new language features
- New documentation (if a feature was previously undocumented).
In a project with multiple contributors, people will use different words to say the same thing. Consider rephrasing changes in order to consistently communicate types of changes to the outside world. In addition, add details where missing or strip details when irrelevant. For example in:
- Upgrade json-parser from 2.2.0 to 3.0.1
- Bump `xml-parser`The first change is too specific (because the dependency is not pinned to that exact version, let's say) while the second change is not specific enough. Instead write:
- Bump `json-parser` from 2.x to 3.x
- Bump `xml-parser` from 6.x to 8.xDon't stray too far from the original commit messages though, because then fellow contributors will not recognize their changes in the changelog. Instead, make an effort on future changes to align terminology between contributors.
If a change happened over multiple commits, consider listing them as one. Here are some examples (with pseudo references for brevity).
Bumping the same dependency twice
- Bump `standard` from 15.x to 16.x (b)
- Bump `standard` from 14.x to 15.x (a)Becomes:
- Bump `standard` from 14.x to 16.x (a, b)Fixups
- Fix code style of new filter (b)
- Support filtering entries by name (a)Becomes:
- Support filtering entries by name (a, b)A changelog entry describes the difference between two releases. If commits between those releases negate each other (for example because one reverts the other) then leave them out of the changelog.
A change should be brief and to the point, no more than one line long. This makes a list of changes easy to scan. Consider that the reader could be presented with changelogs of multiple projects, as is common when dependency updates are batched or when a breaking change has a ripple effect on dependent projects.
Long descriptions should be in commits or other references, even if the long description explains a breaking change. Given a commit like:
Breaking: bump yaml-parser from 4.x to 5.x
Removes the `unsafe` option.
The change should be (links omitted for brevity):
- **Breaking:** bump `yaml-parser` from 4.x to 5.x (`15d5a9e`)The only exception to this rule is if the commit lacks a description. Then one could write:
- **Breaking:** bump `yaml-parser` from 4.x to 5.x (`15d5a9e`). Removes the `unsafe` option.Alternatively, maintain a separate upgrade guide document for semver-major releases.
For promoting a prerelease to a release, choose one of three approaches according to the type of project and the nature of the prerelease.
A. Copy content to release
A generic approach is to copy content from prereleases to the release. Follow the same practices as when creating a changelog entry from commits. Meaning to merge related changes and so forth (as described above). Write the changelog entry as if the prereleases don't exist.
B. Skip changelog entry for prerelease
A prerelease does not need a changelog entry if the prerelease is made for internal testing purposes rather than public consumption, for example to test CI/CD triggered by a git tag.
C. Refer to prerelease
After a round of prereleases that each had a changelog entry, the entry for the release could simply state Stable release based on <prerelease version> (using a notice).
This approach is suitable for private projects with a lengthier release flow where (crucially) all stakeholders are familiar with the contents of a release by the time it's deemed stable. One such flow is to perform Quality Assurance on internally distributed prereleases. By design, the stable release then doesn't contain new content to be communicated.
For example (links omitted):
Click to expand
## [3.1.0] - 2021-07-05
_Stable release based on [3.1.0-rc.2]._
## [3.1.0-rc.2] - 2021-07-04
### Fixed
- Use localized date formats on Schedule page (`a11eb73`)
## [3.1.0-rc.1] - 2021-07-03
### Added
- Add Schedule page listing upcoming events (`59a03a9`)Using git log as a changelog is a bad idea: it's full of noise. This doesn't necessarily mean that the commits are bad. They serve a different purpose: commits are meant to document a step in the evolution of source code.
Similarly, on projects that only land code through Pull Requests it may be tempting to write a changelog by listing those Pull Requests as-is. Which is not too different from listing commits.
For example (links omitted for brevity):
- json-parser 8.0.2 is fixed (#295)
- doc: fix dead link to xml-entities (#296)
- Bump actions/checkout from v2.3.3 to v2.3.4 (#293)
- docs: fix entryWritten example (#294)
- Update test framework (#288)
- docs: use brackets for hyphenated fields (#291)
- fix: membrane options - misleading error message (#292)There are several problems here, stemming from verbatim copying of content that was only meaningful to contributors to begin with. The json-parser change doesn't explain or reference what was fixed. There are insignificant documentation tweaks and maintenance changes that don't affect the distributed software. This changelog is difficult to read both in detail and high level. Having no changelog would even be better because to understand these changes one has to visit each of the commits. Did the changelog reduce or increase reading time?
Here's how one might improve it:
### Changed
- Unpin `json-parser` having fixed alice/json-parser#38 (#295)
### Fixed
- Clarify that hyphenated fields in `filter` option must use brackets (#291)
- Use more specific errors for invalid `membrane` options (#292)Readers that don't use the filter and membrane options can now skip those changes, which leaves them with only one task: follow the link to json-parser to learn what that's about. Or maybe not even that if the above changelog was for a semver-patch release. That's when semver signaling and clean changelogs really shine.
Conventional Commits adds cognitive overhead by injecting itself into the middle of a workflow. Changes do not start or end with commits.
For generating changelogs, Conventional Commits does help to initially categorize changes, but the use of Conventional Commits also means that commit messages must be converted to a more readable form. Using that form in the first place will align content across the board. Starting with stories and epics, then tickets, then commits, then pull requests, then changelogs. Ultimately this means less cognitive overhead, making room for everybody to understand and recognize each change presented in multiple contexts. This is the "end-to-end" approach of Common Changelog.
In Why Use Conventional Commits it's stated to be good for:
Communicating the nature of changes to teammates, the public, and other stakeholders.
Common Changelog instead focuses on making changes descriptive and explaining why a change is made. This tends to be forgotten in Conventional Commits because it gives commit authors the false impression that their messages are descriptive. To be fair, that is a general communication problem that Conventional Commits doesn't aim to solve. It is however a problem that should be prioritized - over automation and over rigid structure.
Common Changelog uses natural language (in the imperative mood) because it fits all contexts, including explaining changes to a stakeholder in person. Writing commit messages should be done like explaining them to humans. First and foremost to consumers, then to contributors and future selves.
Let's see how these Common Changelog principles can improve commit messages and consequently changelogs, by rewriting the commit examples from the Conventional Commits homepage.
Unclear breaking change
This Conventional Commit does not lead with the fact that it's breaking. The description of the feature on the first line does not explain how extending works. The second line does although according to its prefix (BREAKING CHANGE) it's instead supposed to explain why the change is breaking.
feat: allow provided config object to extend other configs
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
Instead write (for example):
Breaking: support extending config files through `extends` key
This config key is now reserved and no longer exposed to userland code.
Breaking change hidden as a refactoring
Instead of:
refactor!: drop support for Node 6
BREAKING CHANGE: refactor to use JavaScript features not available in Node 6.
Write:
Breaking: refactor using new JavaScript features
Drops support of Node 6.
Documentation tweak in unknown file
Instead of:
docs: correct spelling of CHANGELOG
Write (for example):
Fix spelling of CHANGELOG in README
Redundant type and scope information
Instead of:
feat(lang): add polish language
Write:
Add polish translation
Unnecessarily long description
Instead of:
fix: correct minor typos in code
see the issue for details on typos fixed.
Reviewed-by: Z
Refs #133
Write:
Fix minor typos in code (#133)
Reviewed-by: Z
Regional date formats vary throughout the world. The advantage of dates formatted like 2017-07-17 is that they follow the order of largest to smallest units: year, month, and day. This format also doesn't overlap in ambiguous ways with other date formats, unlike some regional formats that switch the position of month and day numbers. These reasons, and the fact this date format is an ISO standard, are why it is the recommended date format for changelog entries.
The following workflow is triggered by a tag and takes the changelog entry for that tag from CHANGELOG.md and creates a GitHub release with the same content. The anton-yurchenko/git-release action that is used here also supports uploading assets to the GitHub release.
name: Release
on:
push:
tags: ['*']
permissions:
contents: write
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Create GitHub release
uses: docker://antonyurchenko/git-release:latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}In one word: reciprocity. Spending a modest amount of time on writing a changelog saves every reader twice as much time.
On any project regardless of git practices, there will be mistakes, noise and miscommunication. That's only natural. If needed a project can move fast in git and slow down for the changelog. The release can wait 15 minutes more.
In git history, a new feature may get described in more than one way because it takes time to develop a vocabulary. Maintainers will merge imperfect pull requests to stop a lenghty back-and-forth. Contributors forget that the quality of their commit messages deteriorates over time as context is lost. And so on.
Writing the changelog is another feedback loop to think things through. A chance to look at the big picture: how do recent pull requests play together? Was anything missed? Does the version number accurately reflect changes? Perhaps changes are breaking in unforeseen ways. Or (rarer) the opposite of that, which could be a waste of semver-major signaling.
Don't take the easy way out with full automation. This results in poor changelogs, defeating their purpose.
Keep a Changelog was one of the first complete guides for writing a changelog. It has solid principles and offers a high-level layout for a changelog. Common Changelog was born to fill in various gaps and leave less room for interpretation. Common Changelog is undoubtedly more opinionated, while equally striving for an approach that's suitable for any project.
More specifically, there are some differences in the changelog format.
Additions
Common Changelog adds references, authors and a way to highlight breaking changes.
Less categories
Common Changelog does not have Deprecated and Security categories. A deprecation can be listed under the Changed category. For example: "Deprecate the security category".
No Unreleased section
Common Changelog does not have an Unreleased section at the top of the changelog, which Keep a Changelog recommends for listing unreleased changes as they land in the main branch of the project. In practice, especially with Common Changelog's addition of references, this is an unproductive workflow:
- Although a commit or pull request could describe itself in the
Unreleasedsection, it cannot add the necessary (self) references. These can only be added after the fact. - First-time contributors can't be expected to update the changelog. Maintainers would have to commit that separately, resulting in a noisy git history.
- Writing a changelog requires a bird's-eye view of the project, while individual changes are typically best reviewed and discussed in isolation.
No [YANKED] tag
Instead of a special notation for yanked releases, Common Changelog uses notices as a more generic (but unparsable) format.
Yes! To promote the use of Common Changelog, the following Markdown can be placed in the project's readme:
[](https://common-changelog.org)A yanked release should still have an entry in the changelog, assuming the release was public for more than a few hours. Add a notice explaining the status of the release and linking to more information if available. For example (links omitted):
## [8.5.1] - 2021-05-10
_This release was never published to npm due to security issues (#123)._The notice should not replace other content (i.e. the list of changes).
Sure. There are always good reasons to improve a changelog and not just the last release. It's a historical record and a useful reference to answer questions like "When did X change?".
No, if a commit convention means to encode information to be consumed by machines. The guidelines of Common Changelog can be used to write commit messages in a certain way and certainly recommend (but don't require) doing so. The key difference however is that Common Changelog targets human readers and avoids encoded communication. To say that feat is a feature and ! denotes a breaking change for example.
