Skip to content

[Release version] — [Release title]

Summary

Summary guidance:

  • Write an elevator pitch from one developer to another, readable at a glance. Keep paragraphs to at most two sentences; split or distill long lines.
  • Use one hook line of at most 25 words, one to five win bullets of at most 20 words each, and one upgrade-call line.
  • Order real user-facing wins by impact; never pad. Describe user outcomes without copying Highlights text.
  • Put breaking or removed items in the upgrade call, not the win bullets; a deprecation may add an optional heads-up clause there. Keep PR references in Highlights and Notable changes.
  • Incremental cycles re-fold this section and may add one New since last draft pointer line after the upgrade call; it names new wins only and is outside the win count.

[Release hook]

  • [User-facing win]

[Upgrade guidance]

Highlights

Present the strongest changes with useful examples or concrete before/after outcomes. Scale to the release; omit filler.

[Release highlights]

Migration guide

Give actionable compatibility guidance. Say “No migration required for this release” only when verified.

[Migration guidance]

Notable changes

[Change category]

  • [Feature or affected area] — [Specific effect and benefit]. [Supporting PR or commit links]

Contributors

Use verified contributor names and contributions; add a handle or profile link only when verified and useful.

  • [Contributor name] ([Optional handle or profile link]) — [Contribution summary].

Full changelog: [Full changelog URL]

Template guidance:

  • Link the verified base/head comparison, or explain an initial release and link its history.
  • Replace every square-bracket placeholder and omit unused optional fields. Writing notes are instructions, not release-note content.
  • Use the project's tone and optional section emojis, preserving these section roles. Omit empty categories.
  • Preserve explicit no-migration/no-human-contributor statements only when supported by evidence.
  • Keep readiness failures and internal evidence paths out of public prose except appropriate draft status when blocked.