Skip to content

Normalize CHANGELOG.md structure #317

Closed
#325
Closed
Normalize CHANGELOG.md structure#317
#325
Labels
documentationImprovements or additions to documentationpriority:lowNice-to-have improvement. Can be deferred without blocking other work.

Description

@nanotaboada
nanotaboada
opened on Apr 12, 2026

Problem

CHANGELOG.md is missing two elements present in all other repos: reference links at the bottom and the release template comment.

Proposed Solution

Apply the following additions to CHANGELOG.md:

  1. Add the <!-- Template for new releases: --> comment block after the last release entry and before the reference links. Use the standard template shared across all repos:
<!-- Template for new releases:

## [X.Y.Z - CLUB_NAME] - YYYY-MM-DD

### Added
- New features

### Changed
- Changes in existing functionality

### Deprecated
- Soon-to-be removed features

### Removed
- Removed features

### Fixed
- Bug fixes

### Security
- Security vulnerability fixes

-->
  1. Add reference links at the very bottom of the file (after the template comment), following the pattern used in all other repos:
[unreleased]: https://github.com/nanotaboada/java.samples.spring.boot/compare/v2.0.1-chelsea...HEAD
[2.0.1 - Chelsea]: https://github.com/nanotaboada/java.samples.spring.boot/compare/v2.0.0-barcelona...v2.0.1-chelsea
[2.0.0 - Barcelona]: https://github.com/nanotaboada/java.samples.spring.boot/compare/v1.0.0-arsenal...v2.0.0-barcelona
[1.0.0 - Arsenal]: https://github.com/nanotaboada/java.samples.spring.boot/releases/tag/v1.0.0-arsenal

Acceptance Criteria

  • Template comment added before the reference links
  • Reference links added at the bottom for all four releases plus [Unreleased]
  • No other content changed

Activity

  1. nanotaboada
    added
    documentationImprovements or additions to documentation
    on Apr 12, 2026

  2. coderabbitai commented on Apr 12, 2026

    @coderabbitai
    coderabbitaibot
    on Apr 12, 2026 – with coderabbitai
    🔗 Related PRs

    #287 - ci(release): implement named releases with tag-based deployment (#252) [merged]
    #291 - docs(changelog): prepare release notes for v1.0.0-arsenal [merged]
    #297 - docs: normalize README structure and add RELEASES.md [merged]
    #305 - docs(changelog): prepare release notes for v2.0.0-barcelona [merged]
    #316 - docs(changelog): prepare release notes for v2.0.1-chelsea [merged]

    📝 Issue Planner

    Check the box below or use the @coderabbitai plan command to generate an implementation plan and prompts that you can use with your favorite coding assistant.

    • Create Plan
    🧪 Issue enrichment is currently in open beta.

    You can configure auto-planning by selecting labels in the issue_enrichment configuration.

    To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

    issue_enrichment:
  auto_enrich:
    enabled: false

    💬 Have feedback or questions? Drop into our discord!

  3. nanotaboada
    added
    priority:lowNice-to-have improvement. Can be deferred without blocking other work.
    on Apr 12, 2026
  4. nanotaboada
    changed the title [-]docs(changelog): normalize CHANGELOG.md structure[/-] [+]Normalize CHANGELOG.md structure[/+] on Apr 12, 2026
  5. nanotaboada
    pinned this issue on Apr 19, 2026
  6. nanotaboada
    added 2 commits that reference this issue on Apr 21, 2026

    docs(changelog): fix unreleased reference link casing (#317)

    bb20656

    Merge pull request #325 from nanotaboada/docs/317-normalize-changelog…

    f298973
  7. nanotaboada
    closed this as completedin #325on Apr 22, 2026
  8. nanotaboada
    unpinned this issue on Apr 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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