docs(skills): add prose-pass skill for comment and changelog brevity - #1035
Open
sirtimid wants to merge 4 commits into
Open
docs(skills): add prose-pass skill for comment and changelog brevity#1035sirtimid wants to merge 4 commits into
sirtimid wants to merge 4 commits into
Conversation
Codifies the standard for comments, changelog entries, and PR bodies as a shared skill, and wires it into the commit, pr, and update-changelogs flows.
Review found the skill instructing edits that break jsdoc/require-description, banning the test summary the pr skill requires in a PR body, and sweeping comments after the review subagents had already run.
…ning it prose-pass edits files and returns no findings, so a review of a remote PR had nothing to act on.
…ctors The pass runs before every commit, so its diff must stay predictable: comments out, at most one identifier renamed.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 51ff46d. Configure here.
| ## Phase 4: Create the PR | ||
|
|
||
| 1. Run `gh pr create` to create a pull request. The PR body should include: | ||
| 1. Draft the PR body, then run the prose pass over the body: Skill tool with skill="prose-pass". The comments were already swept in Phase 1; this pass is for the body only. |
There was a problem hiding this comment.
Unscoped prose pass after review
Medium Severity
Phase 4 invokes prose-pass with no args, so the default full pass still judges comments and may rename identifiers after review. Those file edits are not committed before gh pr create, and can land unreviewed in the later changelog commit.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit 51ff46d. Configure here.
Contributor
Coverage Report
File CoverageNo changed files found. |
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.


Comments, changelog entries, and PR bodies here kept needing the same correction: cut whatever a reader can derive from the code. That standard lived in per-session reminders rather than in the repo, so it only applied when someone remembered to give it. This checks it in.
prose-passstates the bar — the default is no comment, and accuracy alone does not justify one — then the judgements that follow: restatements, log-call preambles, TDD scaffolding, and rationale duplicated across files go; constraints, invariants, and test-shape rationale stay. Every rule is framed as information content rather than phrasing. The openers section is deliberate about this: it lists the patterns models produce constantly (Ensure,This ensures,Note that) but treats them as a signal to inspect rather than a delete list, so// Note that N must stay a power of two.survives.Changes
.claude/skills/prose-pass/SKILL.md— the standard, with separate sections for changelogs (the consumer test) and PR bodies (which need the narrative and testing note a changelog must not carry)commit,pr, andupdate-changelogsinvoke it;commit's checks now run after it, since the pass can rename identifiers or extract functionscode-reviewreads it as review criteria rather than invoking it — it edits files, and a review may have nothing checked outAGENTS.mdpoints at the file by path, so agents with no Skill tool can still complyTesting
No code changed, so this is prettier plus review of the text itself. Three review passes found real defects: the skill originally instructed deletions that break
jsdoc/require-description, banned the testing note theprskill requires in a PR body, and swept comments only after the review subagents had run. Each is fixed in the follow-up commits.Note
Low Risk
Documentation and Claude skill workflow changes only; no runtime or package behavior changes.
Overview
Adds a checked-in
prose-passskill that defines when to cut comments, JSDoc, changelog lines, and PR prose (default: no comment unless the code cannot carry the information), and wires it into agent workflows.commitnow runs the pass on the diff before staging and moveslint-build-testto after the pass so renames or comment trims do not fail checks prematurely.prruns it on diff comments before automated review (with optional trim commit/push), on the drafted PR body beforegh pr create, and on changelog drafts viaargs="changelogs".update-changelogsandcode-reviewreference the same standard (review reads criteria only; it does not invoke the skill).AGENTS.mdlinks the skill for agents without the Skill tool, and.claude/settings.jsonallowsSkill(prose-pass).Reviewed by Cursor Bugbot for commit 51ff46d. Bugbot is set up for automated code reviews on this repo. Configure here.