Skip to content

docs: conform CHANGELOG to Keep a Changelog#13

Merged
serradura merged 2 commits into
mainfrom
chore/changelog-conform
Jun 1, 2026
Merged

docs: conform CHANGELOG to Keep a Changelog#13
serradura merged 2 commits into
mainfrom
chore/changelog-conform

Conversation

@serradura

Copy link
Copy Markdown
Member

What

Docs-only cleanup of CHANGELOG.md and README.md.

CHANGELOG.md

  • Conform to Keep a Changelog: replace the inline per-release [Diff] / [Tag] links with reference-style version links collected at the bottom of the file, and bump the format reference to 1.1.0.
  • Fix the 1.0.0 release date: 2021-01-192022-01-20. The old date was chronologically impossible (it predated 0.12.0 at 2021-12-22); 2022-01-20 matches the actual v1.0.0 git tag.

README.md

  • Add blank lines before lists and code blocks (markdown best practice / consistent rendering); drop a stray <br>.

Why

Keep the user-facing changelog consistent with the conventions it already claims to follow, and correct the inaccurate 1.0.0 date.

Notes

  • No code changes; public API untouched (maintenance mode honored).
  • No CHANGELOG [Unreleased] entry — pure docs change.

🤖 Generated with Claude Code

serradura and others added 2 commits June 1, 2026 18:54
- Fix v1.0.0 release date 2021-01-19 → 2022-01-20 (per the v1.0.0 tag);
  update the TOC entry and anchor to match
- Replace per-section inline [Diff]/[Tag] links with a canonical bottom
  reference-links section (compare links for every version; releases/tag
  for the initial v0.1.0)
- Bump the Keep a Changelog reference from 1.0.0 to 1.1.0

All existing entries and code examples preserved verbatim.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@serradura serradura merged commit afbd025 into main Jun 1, 2026
9 checks passed
@serradura serradura deleted the chore/changelog-conform branch June 1, 2026 23:50
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.

1 participant