Release Notes Template (Markdown)

# {{Product name}} {{X.Y.Z}}

**Released:** {{YYYY-MM-DD}}
**Type:** {{Major / Minor / Patch}}

*One or two sentences: why should a user care about this release?*

{{Summary: the main thing this release does for the reader.}}

## Highlights

- **{{Headline feature}}** — {{one line on what the reader can now do}}. [Docs]({{link}})
- **{{Second highlight}}** — {{...}}

## New

*Written from the reader's side. Link to docs, issue or pull request.*

- {{You can now ...}} ([#{{123}}]({{link}}))
- {{...}}

## Improved

- {{... is now faster / clearer / more flexible}} ([#{{124}}]({{link}}))

## Fixed

- {{Fixed an issue where ... when ...}} ([#{{125}}]({{link}}))

## Breaking changes

*Delete this section only if there are none. Say who is affected, what to change, show before and after.*

- **{{What changed}}.** Affects: {{who}}.
  Before:
  ```text
  {{old behaviour, command or config}}
  ```
  After:
  ```text
  {{new behaviour, command or config}}
  ```

## Deprecations

- {{Feature}} is deprecated and will be removed in {{version or date}}. Use {{replacement}} instead.

## Security

- {{Fixed ... (affects versions A–B, fixed in this release)}} ([advisory]({{link}}))

## Upgrade steps

1. {{Back up ...}}
2. {{Update to X.Y.Z with ...}}
3. {{Run the migration ...}}
4. {{Verify with ...}}

## Known issues

- {{Issue}} — workaround: {{...}} ([#{{126}}]({{link}}))

## Thanks

{{Contributors and reporters, by name or handle.}}

**Full changelog:** {{link to compare view or CHANGELOG.md}}