|
| 1 | +--- |
| 2 | +name: create-pr |
| 3 | +description: Create a pull request with a concise, useful description |
| 4 | +--- |
| 5 | + |
| 6 | +# Create PR Skill |
| 7 | + |
| 8 | +Create pull requests with concise, useful descriptions. |
| 9 | + |
| 10 | +## Philosophy |
| 11 | + |
| 12 | +- **Be brief**: No walls of text. Reviewers skim. |
| 13 | +- **Be specific**: What changed and why, not how (code shows how). |
| 14 | +- **No fluff**: Skip test plans, checklists, and boilerplate sections. |
| 15 | + |
| 16 | +## PR Title |
| 17 | + |
| 18 | +Use format: `<type>: <short description>` |
| 19 | + |
| 20 | +Types: `fix`, `feat`, `refactor`, `docs`, `chore`, `test` |
| 21 | + |
| 22 | +Examples: |
| 23 | +- `fix: handle null user in session lookup` |
| 24 | +- `feat: add workspace pause/resume` |
| 25 | +- `refactor: extract terminal manager from agent` |
| 26 | + |
| 27 | +## PR Description |
| 28 | + |
| 29 | +Keep it short. 2-5 bullet points max. |
| 30 | + |
| 31 | +```markdown |
| 32 | +## Summary |
| 33 | + |
| 34 | +- <what changed> |
| 35 | +- <why it changed> |
| 36 | +- <any notable decisions or tradeoffs> |
| 37 | +``` |
| 38 | + |
| 39 | +That's it. No "Test Plan", no "Screenshots", no checklists unless truly needed. |
| 40 | + |
| 41 | +## Steps |
| 42 | + |
| 43 | +1. Check current state: |
| 44 | + ```bash |
| 45 | + git diff --name-only main...HEAD |
| 46 | + git log --oneline main...HEAD |
| 47 | + ``` |
| 48 | + |
| 49 | +2. Create PR: |
| 50 | + ```bash |
| 51 | + gh pr create --title "<type>: <description>" --body "$(cat <<'EOF' |
| 52 | + ## Summary |
| 53 | + |
| 54 | + - <what> |
| 55 | + - <why> |
| 56 | + EOF |
| 57 | + )" |
| 58 | + ``` |
| 59 | +
|
| 60 | +## When to Add More |
| 61 | +
|
| 62 | +Only add extra sections if genuinely useful: |
| 63 | +
|
| 64 | +- **Breaking changes**: If API/behavior changes affect users |
| 65 | +- **Migration**: If users need to do something |
| 66 | +- **Screenshots**: Only for UI changes, and only if they help |
| 67 | +
|
| 68 | +## Anti-patterns |
| 69 | +
|
| 70 | +- Long descriptions nobody reads |
| 71 | +- Copy-pasting commit messages as bullets |
| 72 | +- "This PR does X" (we know, it's a PR) |
| 73 | +- Test plan sections (CI runs tests) |
| 74 | +- Checklists (use CI for enforcement) |
0 commit comments