Skip to content

docs(changelog): move naming table to top, add separators and template (#92)#104

Merged
nanotaboada merged 1 commit into
masterfrom
docs/normalize-changelog-structure
Apr 27, 2026
Merged

docs(changelog): move naming table to top, add separators and template (#92)#104
nanotaboada merged 1 commit into
masterfrom
docs/normalize-changelog-structure

Conversation

@nanotaboada

@nanotaboada nanotaboada commented Apr 27, 2026

Copy link
Copy Markdown
Owner

Summary

  • Moved "Ballon d'Or Nominees" naming table to the top (after preamble, before [Unreleased])
  • Added --- separators between all release sections
  • Added <!-- Template for new releases: --> comment block before the reference links

Test plan

  • Verify naming table appears at the top, before ## [Unreleased]
  • Verify --- separators present between all sections
  • Verify template comment present before reference links
  • Verify no other content changed

Closes #92

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reorganized changelog with new "Ballon d'Or Nominees 🏅" section containing an A–Z reference table for nominees.
    • Added visual separators around the Unreleased section and between release sections.
    • Introduced HTML comment template to guide formatting of future release entries and subsections.

@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown

Walkthrough

The CHANGELOG.md has been restructured to normalize its format. The "Ballon d'Or Nominees" reference table moved from the bottom to the top, --- separators added between release sections, and a template comment inserted before reference links.

Changes

Cohort / File(s) Summary
Documentation Structure
CHANGELOG.md
Moved nominees table to top (after preamble, before ## [Unreleased]), added --- separators between release sections, and inserted HTML comment template for future releases before reference links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective Addressed Explanation
Move "Ballon d'Or Nominees" section to the top, right after the header and preamble, before ## [Unreleased] [#92]
Add --- separators between each release section [#92]
Add the <!-- Template for new releases: --> comment block before reference links [#92]

Possibly related issues

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title follows Conventional Commits format with 'docs:' prefix, is under 80 characters (76 chars), and accurately describes the main changes: moving the naming table to the top, adding separators, and including a template.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/normalize-changelog-structure
  • 🛠️ sync documentation: Commit on current branch
  • 🛠️ sync documentation: Create PR
  • 🛠️ enforce http error handling: Commit on current branch
  • 🛠️ enforce http error handling: Create PR
  • 🛠️ idiomatic review: Commit on current branch
  • 🛠️ idiomatic review: Create PR
  • 🛠️ verify api contract: Commit on current branch
  • 🛠️ verify api contract: Create PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

#92)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@nanotaboada
nanotaboada force-pushed the docs/normalize-changelog-structure branch from 4b1c6d0 to ad33f46 Compare April 27, 2026 00:18
@nanotaboada nanotaboada changed the title docs(changelog): normalize structure to match sibling repos (#92) docs(changelog): move naming table to top, add separators and template (#92) Apr 27, 2026
@codecov

codecov Bot commented Apr 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.88%. Comparing base (d4d7720) to head (ad33f46).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #104   +/-   ##
=======================================
  Coverage   84.88%   84.88%           
=======================================
  Files           6        6           
  Lines         172      172           
=======================================
  Hits          146      146           
  Misses         26       26           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nanotaboada
nanotaboada merged commit df181fe into master Apr 27, 2026
10 checks passed
@nanotaboada
nanotaboada deleted the docs/normalize-changelog-structure branch April 27, 2026 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Normalize CHANGELOG.md structure

1 participant