Repository navigation
State the general changelog rule in AGENTS.md - #302
Merged
Merged
Conversation
moCello
marked this pull request as ready for review
October 7, 2026 15:40
moCello
requested review from
HDauven,
Neotamandua,
d-sonuga,
herr-seppia and
xevisalle
October 7, 2026 15:40
herr-seppia
reviewed
Oct 7, 2026
Replace the changelog guidance with one rule: entries cover only changes that users of the crate can see, and the rule says how to write, place and link an entry. Keep the Keep a Changelog format, the GitHub-only links and the markdown formatting guidance.
CONTRIBUTING.md stated its own, looser changelog rule. Replace it with a pointer to the changelog section of AGENTS.md, so that one rule applies.
Criterion is a dev-dependency, so users of the crate do not see the benchmark consolidation or the Criterion update. Remove both entries and their link definitions.
moCello
force-pushed
the
mocello/poseidon252-changelog-rule
branch
from
October 7, 2026 15:51
21408e2 to
4f73a7a
Compare
HDauven
approved these changes
Oct 7, 2026
xevisalle
approved these changes
Oct 8, 2026
Say the same in fewer words, so the section costs readers less.
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
4 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.mdlimits entries to user-visible changes, but it does not say what a good entry looks like. Entries 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.Replace that guidance with one changelog rule. Entries cover only changes that users of the crate can see, and tests, CI, tooling and internal refactors get no entry. The rule also says how to write, place and link an entry. It keeps the Keep a Changelog format, the GitHub-only links and the markdown formatting guidance.
CONTRIBUTING.mdstated its own, looser changelog rule. Replace it with a pointer to the changelog section ofAGENTS.md.Apply the rule to
[Unreleased]once. Remove the entries that users of the crate cannot see, and their link definitions: