Repository navigation
Says when the changelog preamble may change - #191
Merged
Merged
Conversation
.claude/wurk/commit.md says CHANGELOG.md is never edited outside a release, and an earlier documentation fix had to change the preamble's changelog.d/README.md link from a relative path to a tag URL, which the rule's wording neither allowed nor forbade. One sentence now settles it: an edit outside every version section, the preamble or a link in it, is permitted outside a release only when it fixes a broken or stale link or a stale preamble fact, and changes no version section's text. Agent tooling only; no file under lib/ changes and no fragment. Refs: sui-y8se
johnnyt
force-pushed
the
sui-y8se-changelog-preamble-rule
branch
from
October 11, 2026 15:07
0478374 to
4c54c12
Compare
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
1 participant
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.
Refs: sui-y8se
What
.claude/wurk/commit.md, "Changelog: fragments": the paragraph that saysCHANGELOG.mdis never edited outside a release gains one sentence naming the exception: an edit outside every version section (the preamble, or a link in it) is permitted outside a release only when it fixes a broken or stale link or a stale preamble fact, and changes no version section's text.Why: an earlier documentation fix had to turn the preamble's relative
changelog.d/README.mdlink into a URL at a release tag, because HexDocs rewrote the relative link to the package's front page. The rule's wording neither allowed nor forbade that edit. The answer it now gives was decided by the conductor under a standing consent, 2026-10-11.This PR does not edit
CHANGELOG.md.Gate
Full
mix qualitygreen on this head: every stage passed, 1,214 of 1,214 tests, 93.7% coverage, attested bymix quality.verify. The skip lines are Diataxis (project-level, opt-in), Gettext and Sobelow (not applicable), as before.No changelog fragment: agent tooling takes none under
changelog.d/README.md.Review
In-turn review of the diff: one sentence appended to one paragraph; it narrows nothing else in the file, and it agrees with
.claude/wurk/release.md, which owns the at-release edits. No record text in this PR.