Skip to content

Changelog Guidelines

Use Keep a Changelog style and record all user-visible changes.

Required sections

Under ## [Unreleased]:

  • ### Added
  • ### Changed
  • ### Fixed
  • ### Removed
  • ### Security

Writing rules

  • describe what changed and why it matters
  • include module/package names when possible
  • avoid vague lines like "misc improvements"

Release step

Before release, ensure Unreleased entries are complete and not left as TBD.

Released under the MIT License.