docs(agents): align AGENTS.md §11 changelog/release contract with ADR-0038#88
Merged
Merged
Conversation
…0038 PR #87 split the changelog into per-version files (ADR-0038) and updated release.md + the version-lockstep lint, but AGENTS.md section 11 still described the old "roll Unreleased into a version block in the same file" mechanic and did not mention docs/changelog/. Update the CHANGELOG paragraph and the release-table row so the primary agent contract matches the shipped structure; extend the (still-unreleased) changelog entry to note the AGENTS.md alignment. Documentation-only; no API, ABI, or build change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Summary
Closes a gap left by PR #87: that PR split the changelog into one immutable file
per release (ADR-0038) and updated
release.md+ theversion-locksteplint, butAGENTS.md§11 — the primaryagent contract — still described the old roll Unreleased into a version block in
the same file mechanic and never mentioned
docs/changelog/.Changes
AGENTS.md§11 — theCHANGELOG.mdparagraph now states that releasedentries are immutable per-version files under
docs/changelog/v<MAJOR>/v<X.Y.Z>.mdand that the root file keeps only
[Unreleased]+ the index; the release-tablerow changed from Update CHANGELOG.md (Unreleased → version) to Move Unreleased
→ docs/changelog/v/v<X.Y.Z>.md + index row.
CHANGELOG.md— extended the (still-unreleased) changelog-split entry to notethe AGENTS.md §11 alignment.
Context — agent-rule audit
Triggered by a check that all three docs-structure rules are wired into the agent
contract. Result:
AGENTS.md§7.6 ✅ (ADR-0036)AGENTS.md§7.3 ✅ (ADR-0037)AGENTS.md§11The PR-template checklist and CLAUDE.md TL;DR remain accurate (they reference
adding to
CHANGELOG.mdUnreleased, which is unchanged).python tools/consistency_lint.py→ OK. Documentation-only.🤖 Generated with Claude Code