38 lines
719 B
Markdown
38 lines
719 B
Markdown
---
|
|
name: release-notes
|
|
description: Draft structured release notes from a bullet list of changes.
|
|
---
|
|
|
|
# Release Notes Template
|
|
|
|
Use this template to ship release notes fast. Fill the sections below;
|
|
delete any that are empty. Keep user-facing impact front and center.
|
|
|
|
## [X.Y.Z] — YYYY-MM-DD
|
|
|
|
### Added
|
|
- _New capabilities_
|
|
|
|
### Changed
|
|
- _Modifications to existing behavior_
|
|
|
|
### Fixed
|
|
- _Bug fixes with impact_
|
|
|
|
### Security
|
|
- _Vuln patches, dependency updates_
|
|
|
|
### Deprecated
|
|
- _Features scheduled for removal_
|
|
|
|
### Removed
|
|
- _Deleted features_
|
|
|
|
---
|
|
|
|
## Instructions
|
|
1. Replace `X.Y.Z` and date.
|
|
2. List only user-visible changes.
|
|
3. Link tickets or PRs when available.
|
|
4. Run `test -s <file>` before sending.
|