Modernize CHANGELOG.md, add gemspec bug tracker link, and add CLAUDE.md#76
Merged
Conversation
Rewrite CHANGELOG.md to follow the Keep a Changelog 1.1.0 spec and backfill the gap left by the prior format: every tagged release from 0.1.0 (Dec 2019) through 6.0.0 (May 2026) is now documented, including the previously omitted 3.0.1 patch and the 6.0.0 major (Ruby floor raised to >= 2.7, Appraisal-driven matrix, Qlty coverage, Kind::Maybe #to_proc). Sections follow the Added / Changed / Deprecated / Removed / Fixed / Security ordering, and each version has a GitHub compare link. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds bug_tracker_uri so RubyGems.org surfaces a direct link to the issue tracker from the gem page. homepage_uri, source_code_uri and changelog_uri were already wired up. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Documents the CHANGELOG modernization (Keep a Changelog 1.1.0 + backfill of 0.1.0..6.0.0 including the previously omitted 3.0.1 patch and the 6.0.0 major) and the new spec.metadata bug_tracker_uri entry introduced in this branch. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Bump the Documentation table and Compatibility table to 6.0.1 (dependency bounds unchanged from 6.0.0). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Includes the four "How to work in this repo" rules (Think before coding, Simplicity first, Surgical changes, Goal-driven execution) plus the project-specific sections covering what the gem is, how to run tests (rake / appraisal / matrix / test_basic_modules), the requirement to keep CHANGELOG.md and README.md in sync with user-visible changes, and the bump checklist (version constant, changelog entry + compare link, README Documentation/Compatibility tables, Appraisals matrix). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CHANGELOG.mdfrom the older custom format (manual TOC, ad-hoc section names) to the Keep a Changelog 1.1.0 spec, with compare links per release. Coverage extended from the previous stop point (v5.10.0, Sep 2021) up through v6.0.1 — including the previously-missing v3.0.1 patch, v6.0.0, and v6.0.1.bug_tracker_uritospec.metadata(existinghomepage_uri/source_code_uri/changelog_uriwere already wired).6.0.0→6.0.1(patch) — the bump itself only documents the CHANGELOG modernization + metadata addition.CLAUDE.mdmirroring the structure shipped inu-case: the four Karpathy-style behavioral guidelines (Think before coding / Simplicity first / Surgical changes / Goal-driven execution) followed by repo-specific orientation (what the gem is, how to run tests + the appraisal matrix, the CHANGELOG/READMEs contract, the version-bump checklist).6.0.1.Notes on the CHANGELOG rewrite
Changed; old "Breaking Changes" sub-sections →Changedwith**BREAKING:**prefix, matching the u-case convention.Kind::Maybe#to_proc) was folded into the v6.0.0 release notes (where it actually shipped), with @tomascco attribution preserved.Test plan
bundle exec rake test— 196 runs, 1875 assertions, 0 failures, 100% line coverage🤖 Generated with Claude Code