Neon-Vision-Editor/release/RELEASE_NOTES_TEMPLATE.md

35 lines
682 B
Markdown
Raw Normal View History

# Release Notes Template
Use this exact structure for each release section in `CHANGELOG.md`.
```md
## [vX.Y.Z] - YYYY-MM-DD
### Hero Screenshot
- ![vX.Y.Z hero screenshot](docs/images/<hero-image>.png)
### Why Upgrade
- <user-facing reason 1>
- <user-facing reason 2>
- <user-facing reason 3>
### Highlights
- <major enhancement>
- <major enhancement>
### Fixes
- <important bug fix>
- <important bug fix>
### Breaking changes
- None.
### Migration
- None.
```
Rules:
- Keep `Why Upgrade` to at least 3 concise bullets.
- Always include exactly one hero screenshot in the `Hero Screenshot` section.
- If no breaking changes or migration steps exist, keep `None.` entries.