Changelog

Purpose

Tell users what changed and what they must do about it. A changelog is not a git log; it is a communication with people who have built something on your software.

When to Use

• Writing release notes.
• Maintaining a CHANGELOG file.
• Announcing a breaking change.
• Deciding a version number.

Capabilities

• Changelog structure and categorization.
• Writing for users rather than for contributors.
• Semantic versioning.
• Breaking-change communication and migration guidance.