Repository navigation
State the general changelog rule in AGENTS.md - #1010
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1010 +/- ##
=======================================
Coverage 92.31% 92.31%
=======================================
Files 80 80
Lines 8924 8924
=======================================
Hits 8238 8238
Misses 686 686 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
AGENTS.md did not say which changes need a changelog entry, or what a good entry looks like. Add a changelog section: entries cover only changes that users of the crate can see, and the section says how to write an entry, choose its section and link its issue.
CONTRIBUTING.md kept its own, looser changelog rule. Replace it with a pointer to the changelog section of AGENTS.md, so one rule applies.
The [Unreleased] section listed changes that touched only tests, benchmarks or development dependencies. Users of the crate see none of them. Remove those five entries and the link definitions that no entry uses any more.
moCello
force-pushed
the
mocello/plonk-changelog-rule
branch
from
October 7, 2026 15:56
f72ec48 to
0e745a7
Compare
moCello
marked this pull request as ready for review
October 7, 2026 16:03
moCello
requested review from
HDauven,
Neotamandua,
d-sonuga,
herr-seppia and
xevisalle
October 7, 2026 16:03
HDauven
approved these changes
Oct 7, 2026
xevisalle
approved these changes
Oct 8, 2026
Neotamandua
reviewed
Oct 8, 2026
Say the same in fewer words, so the section costs readers less.
herr-seppia
approved these changes
Oct 8, 2026
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
5 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.
Summary
The changelog guidance in
AGENTS.mddoes not say which changes need an entry, or what a good entry looks like. Agents and automated reviewers then ask for entries on changes that users cannot see, such as test-only PRs. Entries also often need corrections in review: several facts in one entry, the mechanism instead of the visible effect, the wrong section, or a missing issue link.Add the company-wide changelog rule to
AGENTS.md. Entries cover only changes that users of the crate can see. The rule also says how to write, place and link an entry, and which format the file follows.CONTRIBUTING.mdhad its own, looser changelog rule. Replace it with a pointer to the changelog section ofAGENTS.md.Apply the rule once to
[Unreleased]inCHANGELOG.md. Remove the entries whose change touched only tests, benchmarks or development dependencies, and the link definitions that only they used:itertoolsdependency [Update benchmark dependencies #953]" (dev-dependencies and benchmarks)tempdirdevelopment dependency withtempfile[Replace tempdir with tempfile #949]" (dev-dependency and tests)