Skip to content

Normalize CHANGELOG.md structure #468

@nanotaboada

Description

@nanotaboada

Problem

CHANGELOG.md has two structural issues that need to be fixed for consistency across all repos.

Proposed Solution

Apply the following changes to CHANGELOG.md:

  1. Remove the ## How to Release section (the full block including the pre-release checklist and step-by-step instructions) — this content belongs in RELEASES.md, not in the changelog. Keep the <!-- Template for new releases: --> comment that follows it.

  2. 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 Release section removed; template comment kept
  • All five codenames capitalized in ## headers
  • All five codenames capitalized in reference links at the bottom
  • No other content changed

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority lowNice-to-have improvement. Can be deferred without blocking other work.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions