docs(agents): tighten the comment rule, and let the changelog skill own its own style - #1036
Open
lukecotter wants to merge 2 commits into
Open
docs(agents): tighten the comment rule, and let the changelog skill own its own style#1036lukecotter wants to merge 2 commits into
lukecotter wants to merge 2 commits into
Conversation
… skill The old bar, "only the non-obvious", read as permission. State the test a comment has to pass instead. The CHANGELOG rules were a stale summary of the changelog-entry skill; link it rather than repeat it.
…ouse style - a big feature can carry up to three sub-bullets, one capability each - the emoji-and-label form and the generated lana/CHANGELOG.md copy were unwritten; both are now in the skill - section order corrected to Added, Changed, Removed, Fixed
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.
Two rules that were wrong in practice.
The comment bar. "Only the non-obvious: a why, a gotcha, an invariant" reads as permission, and agents take it that way — a summary passes as a why, a signpost passes as a gotcha. The new wording states the test a comment has to pass: without this line a competent reader would make a wrong change.
CHANGELOG rules lived in two places.
AGENTS.mdcarried a summary that had drifted from thechangelog-entryskill. It now links the skill.The skill gained what the file already does. Sub-bullets were banned outright, yet the Unreleased section uses them well for one feature with distinct parts — three at most, one capability each. Also recorded: the
- <emoji> **Label**: …house form, that thelana/copy is generated so only the root file is edited, and the section order the file actually uses (Added, Changed, Removed, Fixed).Touches
AGENTS.mdand.claude/skills/changelog-entry/SKILL.mdonly. No code.Note: #893 also edits
AGENTS.md, in a different section.