AGENTS.md: golden rule — no newsfragment unless certain a change is user-facing#67982
Merged
Merged
Conversation
…is user-facing Agents (and contributors) have been adding newsfragments for changes that are not user-facing — build/release tooling, CI, internal refactors — which then have to be removed in review. Make the expectation explicit: a newsfragment is only for changes certainly visible to users; when in doubt, omit it and let a maintainer request one during review.
7 tasks
jscheffl
approved these changes
Jun 4, 2026
jscheffl
left a comment
Contributor
There was a problem hiding this comment.
Thanks, hoping this improves a lot in regards of false-positive newsfragments flooding PRs recently...
Member
Author
To be honest, this was quite interesting, I do not remmeber exactly how it came to being but it looks like I asked it for the newsfragment separately because it was separate commit. But definitely there is something with newsfragments that agents add them more often than needed - so being pretty explicit about it might help. |
1 task
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
2 participants
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.
Agents (and contributors) keep adding newsfragments for changes that are not user-facing — build/release tooling, CI, internal refactors — which then have to be removed during review (e.g. on the reproducible-build dirty-check fix).
This makes the expectation explicit in
AGENTS.md(and via theCLAUDE.mdsymlink): a newsfragment is only for changes that are certainly visible to users; when in doubt, omit it and let a maintainer request one in review. Strengthens the two existing newsfragment mentions into a clear golden rule rather than the previous "do not add by default" phrasing.No behavior change — documentation/agent-guidance only.
Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Opus 4.8) following the guidelines