← ClaudeAtlas

rjv-pr-descriptionslisted

Use when writing, generating, updating, or fixing a GitHub PR description. Applies the Current-way/New-way + What-To-Test format; on update preserves checked checkboxes + author content; posts the result.
rjvim/ai-skills · ★ 0 · AI & Automation · score 63
Install: claude install-skill rjvim/ai-skills
# PR Descriptions ## Format One section per logical change: ``` ## Change N: <Short Title> Current way: <one sentence — what happens today>. New way: <one sentence — what happens after this PR>. ### What To Test - [ ] <Action verb: Create / Open / Submit / Uncheck…> - [ ] Confirm <observable outcome>. - [ ] <Edge case setup> - [ ] Confirm <edge case outcome>. ``` **Rules:** - "Current way / New way" — plain English, user-facing behavior only. No code, no implementation details. - Test steps start with an action verb. Confirm steps start with "Confirm". - Cover happy path + key edge cases. Not exhaustive — just the combinations that matter. - No filler. No "Overview" or "Summary" headers. Jump straight to the changes. - No AI signature, attribution, or generator footer (`Generated by Claude`, `Generated by Codex`, model names, badges, or equivalents) unless the human explicitly asks for it. ## Workflow ### Writing a new description 1. Read the actual diff: `gh pr diff <number>`. For context (title, commits, existing body): `gh pr view <number> --json title,commits,body`. 2. Identify logical changes (one section per change). 3. Write sections in the format above. 4. Post: `gh pr edit <number> --body-file -` (pipe the body in; inline `--body` breaks on multi-line/special chars). ### Updating an existing description 1. Fetch current body first: `gh pr view <number> --json body` 2. Preserve all `- [x]` checked checkboxes — never uncheck or remove them. 3. Preserve a