Release Notes Template

Use this structure when reviewing the draft GitHub Release generated by Release Drafter.

Template

Release Drafter creates a draft GitHub Release after changes are merged to main. Before publishing, release owners should edit the draft body so it follows this structure. Each section should be concise and user-facing:

Explain why the change matters.
Link related PRs or issues.
Call out migration and deploy requirements.
Include rollback or mitigation notes for infrastructure changes.

Pull Request Inputs

Release notes are generated from pull request titles, authors, numbers, and release:* labels. Use a clear PR title and fill in the Release Notes section in the PR template so the release owner can quickly rewrite the generated draft into public-facing language.

Example

## v0.5.0 - 2026-05-11

### Summary

This release adds the first public open-source docs skeleton and release process.

### Features

- Added docs pages for templates, references, and open-source contribution.

### Fixes

- Fixed broken navigation entries.

### Breaking Changes

- None.

### Infrastructure and Migrations

- None.

### Documentation

- Added release process and docs versioning pages.

### Upgrade Notes

- No action required.

### Known Issues

- Some pages are still first-pass content and need final design.

​Template

​Pull Request Inputs

​Example

Template

Pull Request Inputs

Example