Skip to content

Latest commit

 

History

History
12 lines (8 loc) · 863 Bytes

CHANGELOG_FORMAT.md

File metadata and controls

12 lines (8 loc) · 863 Bytes
Raw

How to write a good changelog entry

  1. Enter your changes into UNRELEASED.md, not CHANGELOG.md.
  2. Add 'Breaking', 'Added' or 'Fixed' in bold depending on if the change will be major, minor or patch according to semver.
  3. Add the package name.
  4. Detail the changes. Write with the consumer in mind, what do they need to know. If it's patch, tell them what's changed. If it's minor, tell them what you've added and what it does for them. If it's breaking, tell them what they need to change. Link to examples on the Backpack docs site where possible.

Don't worry about adding the specific version number or the date. This will be done by a Backpack squad member as part of the release process.

Example of a good changelog entry

See CHANGELOG.md for real-world examples of good changelog entries.