How We Write Release Notes

A useful release note answers three questions fast:

  1. What changed?
  2. Why should I care?
  3. What do I need to do?

Entry format

Each entry should include:

  • date and scope
  • change summary grouped by area
  • breaking/behavioral changes called out explicitly
  • upgrade or migration actions if required
  • Product
  • Admin
  • Self-Host
  • Developers/API
  • Security/Fixes

Commit history policy

Release notes are not a raw commit log.

Use release notes for external impact. Keep full commit-level detail in repository history and compare views.

Previous
Release Notes
Next
2026