Skip to content

Normalize CHANGELOG.md structure #567

@nanotaboada

Description

@nanotaboada

Problem

CHANGELOG.md contains a ## How to Release prose section that belongs in RELEASES.md, not in the changelog.

Proposed Solution

Remove the ## How to Release prose block — the numbered steps, tag format examples, CD workflow description, and pre-release checklist. Keep the <!-- Template for new releases: --> comment and the reference links that follow it. No other content should change.

The block to remove is the text starting with ## How to Release through the end of the pre-release checklist, stopping before the template comment.

Acceptance Criteria

  • ## How to Release prose removed
  • <!-- Template for new releases: --> comment kept in place
  • Reference links at the bottom unchanged
  • 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