Repository navigation
State the general changelog rule in AGENTS.md - #60
Merged
Merged
Conversation
Limit changelog entries to changes that users of a crate can see, and state how to write, place and link an entry.
Say the same in fewer words, so the section costs readers less.
moCello
marked this pull request as ready for review
October 8, 2026 09:15
moCello
requested review from
HDauven,
Neotamandua,
d-sonuga,
herr-seppia and
xevisalle
October 8, 2026 09:15
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
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.
Summary
The changelog section of
AGENTS.mdsaid where entries go and how to link an issue. It did not limit entries to changes that users of a crate can see. It also did not say how to word an entry or which section to choose.This PR replaces that section with the changelog rule that all actively developed Dusk repositories share. The only changes to the shared text are the heading level and the per-crate wording, because each crate in this workspace has its own
CHANGELOG.md.No other doc in the repository states a changelog rule, so no pointer is needed. Both
[Unreleased]sections are empty, so no entry is removed.