Stop maintaining a running Unreleased section in CHANGELOG.md - #223
Merged
Conversation
Every PR added its own bullet to CHANGELOG.md's ## [Unreleased] section. With PRs landing close together, that turned it into a near-guaranteed merge conflict on every concurrent pull request -- the same problem DOC.md caused before it was dropped in favor of pkg.go.dev. This surfaced concretely while fixing merge conflicts on PRs #219-#222: each resolution round immediately conflicted again as the next PR merged, because they all inserted into the same spot. Freeze the existing Unreleased section as a one-time snapshot and stop editing this file per PR. Unreleased changes are now covered by GitHub's auto-generated release notes; CHANGELOG.md only gains a new entry when a version is actually tagged, added by hand at that point from the generated release notes. Update CLAUDE.md's conventions section to match: PRs no longer touch CHANGELOG.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FLdVmP5daHiknrTW4Geh2i
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #223 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 52 52
Lines 920 920
=========================================
Hits 920 920 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Problem
Every PR added its own bullet to
CHANGELOG.md's## [Unreleased]section, always inserting at (or near) the same spot. With PRs landing close together, that made this file a near-guaranteed merge conflict on every concurrent pull request — the exact problemDOC.mdcaused before #180 dropped it in favor of pkg.go.dev.This wasn't theoretical: it's what just happened resolving conflicts on #219–#222. Each conflict resolution round immediately conflicted again as the next PR merged, because every remaining branch's
### Fixedentry inserted into the same place.Fix
## [Unreleased]section as a one-time snapshot (documenting the six P0 bugfixes plus the earlier accumulated Added/Changed/Removed entries) and add a note explaining the new policy at the top of the file.CHANGELOG.mdonly gains a new entry when a version is actually tagged, added by hand from that release's generated notes (a maintainer decision, not a per-PR one).CLAUDE.md's conventions section: PRs no longer touchCHANGELOG.md.No code changes; docs/process only.
🤖 Generated with Claude Code
https://claude.ai/code/session_01FLdVmP5daHiknrTW4Geh2i