docs: require CHANGELOG updates for user-visible changes - #13
Merged
Conversation
Adds a "Changelog updates" section to AGENTS.md documenting when and how to update CHANGELOG.md under [Unreleased]; clarifies that the release process promotes the existing section rather than writing one from scratch. Adds a CI workflow that fails PRs touching internal/, cmd/, services/, or README.md without a CHANGELOG.md update, skippable via the skip-changelog label or [no-changelog] in the PR title.
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.
Closes #12.
Summary
AGENTS.md(CLAUDE.mdis a symlink) defining what counts as a user-visible change, how to write[Unreleased]entries, and the enforcement mechanism.[Unreleased]section to a versioned header instead of writing notes from scratch at release time.README.mdpointing at the new guidance..github/workflows/changelog.yml: a PR check that fails wheninternal/,cmd/,services/, orREADME.mdchange without aCHANGELOG.mdupdate. Skippable for genuinely non-user-visible changes via theskip-changeloglabel or[no-changelog]in the PR title.[Unreleased]entry inCHANGELOG.mdfor this very change.Test plan
Changelog / Require CHANGELOG entryjob passes on this PR (the PR itself includes aCHANGELOG.mdupdate).Test,Build,Cross-platform Build) stay green.make testandmake vetpass;gofmt -s -l .is empty.