docs: link CHANGELOG.md from README - #15
Merged
Merged
Conversation
CHANGELOG.md doesn't exist yet - release-please creates it as part of its first merged release PR - but the link is stable and will resolve once that lands. Keeping the rich per-version README sections as the primary changelog (they explain why, not just what); CHANGELOG.md is the terser, automatically generated commit-by-commit record underneath, not a replacement for them. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
dconlan
added a commit
that referenced
this pull request
Sep 3, 2026
Makes the CHANGELOG.md link added to README.md (#15) resolve to a real file instead of a 404, ahead of the first real release-please run creating it for real. Verified this is safe by reading release-please's actual updater source (`updaters/changelog.js` in the npm package): content is coerced with `content || ''`, and an empty string is falsy, so a 0-byte file takes the exact same code path as a genuinely absent file — clean header + first entry, nothing demoted or duplicated. Any non-empty placeholder text, by contrast, survives the bootstrap but gets pushed below the first release entry as an orphaned, permanently-demoted sub-heading — confirmed from the same source, not worth risking. No conflict with #15 (different file) — can merge in either order. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 5 <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.
CHANGELOG.md doesn't exist yet — release-please creates it as part of its first merged release PR — but the link is stable and will resolve once that lands.
Keeping the rich per-version README sections as the primary changelog (they explain why, not just what); CHANGELOG.md is the terser, automatically generated commit-by-commit record underneath, not a replacement for them.
Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com