chore: add the writing-changelog skill and route CHANGELOG.md edits through it - #92
Merged
Merged
Conversation
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
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.
Closes: no issue; follows up the agentic setup in #85.
What changed
Changelog entries were leaking implementation detail: the two entries written after #85 landed ran seven to ten lines and named internal functions, processes and a file descriptor. No skill covered the changelog.
implement-issuecalled the changelog line "separate" from the docs written withwriting-user-docs, its finish step named no skill, andwriting-user-docshas no length rule (its "concise means no filler, not short" pushes the other way) and no example of an entry.This adds
.claude/skills/writing-changelog: one bullet per change, a bold<Kind>: <what the user notices>part plus at most one more sentence, a list of what never goes in an entry, a leaked-versus-clean example pair, and theBreakingkind thatcut-releasekeys the version bump off. Voice and scope rules stay inwriting-user-docsand apply by reference.Wiring so agents reach it without relying on description matching: AGENTS.md rule 6 and the skills table, both changelog steps in
implement-issue, a dedicated finding inreview-pr, the PR template checklist, theCHANGELOG.mdheader, and aLESSONS.mdsection.Acceptance criteria
Agent setup only; no code, no tests.
CHANGELOG.mdnameswriting-changeloggrep -rn writing-changelog .claude/skills AGENTS.md .githubE2E evidence
not applicable
Checklist
CHANGELOG.mdhas an entry underUnreleased(writing-changelogskill), or the change is not user-visiblewriting-user-docsskill), or the change is not user-visibleindex.ts; no new directnode:*I/O outside an adapterarchitectureskill applied, exceptions explained abovedocs/ARCHITECTURE.mdupdated if a surface it describes changedOut of scope
The existing entries under
0.11.0and0.11.1are not rewritten; released sections stay as published. APreToolUsehook onCHANGELOG.mdedits was considered and left out until the skill references prove insufficient.Status
Implement: done Review: pending E2E: not applicable Ready: yes