docs: add agent rule for changelog fragment content - #10400
Open
ogenstad wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
No issues found across 1 file
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Shadow auto-approve: would auto-approve. Adds a documentation-only rule file guiding AI agents on writing user-facing changelog fragments. No product behavior, contracts, or operations change; it is bounded documentation tooling.
Re-trigger cubic
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
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.
Why
Changelog fragments regularly get written as if the reader had the diff in front of them: module
paths, class names, and the shape of the fix. Towncrier publishes those files verbatim in the
release notes, where the audience is people running Infrahub, not the people who wrote the patch.
The
creating-changelog-entriesskill covers the mechanics (naming, change types,towncrier create), but nothing is attached to the files themselves at edit time.What changed
.agents/rules/changelog-entries.md, scoped tochangelog/*.md, so it loads whenevera fragment is being written or edited.
docs/docs/development/changelog.mdxrather than duplicating them:branches, schema, or upgrade; for a fix, what looked broken from the outside.
license to pad a one-line fix.
references in the body since the filename carries them and Towncrier renders the link.
.claude/rulesis a symlink to.agents/rules, so no adapter mirroring was needed.How to review
Read the rule against the fragments currently in
changelog/- they are the examples theguidance was calibrated against.
Impact & rollout
Documentation for AI coding agents only. No product code, no behavior change.
Checklist
uv run towncrier create ...)