Release Notes Format


Each release note should answer three questions:

  1. What changed?
  2. Why does it matter?
  3. What action should users take?

Our standard format:

  • Highlights: concise summary of major outcomes
  • Breaking Changes: explicit upgrade impact
  • Fixes: behavior regressions and stability fixes
  • Validation Notes: what was tested before release

This keeps notes scannable for operators and useful for developers doing incident triage later.