-
Notifications
You must be signed in to change notification settings - Fork 18
Normalize CHANGELOG.md structure #468
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationpriority lowNice-to-have improvement. Can be deferred without blocking other work.Nice-to-have improvement. Can be deferred without blocking other work.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationpriority lowNice-to-have improvement. Can be deferred without blocking other work.Nice-to-have improvement. Can be deferred without blocking other work.
Problem
CHANGELOG.mdhas two structural issues that need to be fixed for consistency across all repos.Proposed Solution
Apply the following changes to
CHANGELOG.md:Remove the
## How to Releasesection (the full block including the pre-release checklist and step-by-step instructions) — this content belongs inRELEASES.md, not in the changelog. Keep the<!-- Template for new releases: -->comment that follows it.Capitalize release codenames in
##version headers and in the matching reference links at the bottom:[1.0.0 - azteca]→[1.0.0 - Azteca][1.1.0 - bernabeu]→[1.1.0 - Bernabeu][2.0.0 - centenario]→[2.0.0 - Centenario][2.1.0 - dusseldorf]→[2.1.0 - Dusseldorf][2.1.1 - ekaterinburg]→[2.1.1 - Ekaterinburg]Acceptance Criteria
## How to Releasesection removed; template comment kept##headers