| name | creating-pr |
| description | Creates pull requests with quality descriptions. Use when asked to create a PR, open a pull request, or ship code for review. Requires test verification before PR creation. |
Creating PR Skill
Create pull requests with clear descriptions that enable efficient reviews.
The Iron Law
NO PR WITHOUT PASSING TESTS
Before creating any PR, verify tests pass. No exceptions.
Workflow
1. Verify Tests Pass (MANDATORY)
Run full test suite before anything else:
npm test
echo $?
If tests fail: Fix them first. Do not proceed to PR.
2. Verify Branch State
git branch --show-current
git status
git log main..HEAD --oneline
git diff main...HEAD --stat
3. Push Branch
git push -u origin <branch-name>
4. Analyze Changes
Understand the full scope:
- What commits are included?
- What files changed?
- What's the user-visible impact?
git log main..HEAD
git diff main...HEAD
5. Write PR Description
Title format:
<type>: <short description>
Keep under 72 characters. Use imperative mood.
Description structure:
## Summary
Brief explanation of what this PR does and why.
## Changes
- Bullet point of key changes
- Another change
- Third change
## Testing
How to test this PR:
1. Step one
2. Step two
3. Expected result
## Verification
- [x] All tests pass
- [x] Linting passes
- [ ] Manual testing completed
## Notes for Reviewers
- Any specific areas to focus on
- Known limitations
6. Create the PR
gh pr create --title "type: description" --body "$(cat <<'EOF'
## Summary
What and why.
## Changes
- Change 1
- Change 2
## Testing
1. How to test
2. Expected result
## Verification
- [x] All tests pass
EOF
)"
Quick Reference
PR Title Prefixes
| Prefix | When to Use |
|---|
feat: | New feature |
fix: | Bug fix |
refactor: | Code restructuring |
docs: | Documentation |
test: | Test changes |
chore: | Maintenance |
perf: | Performance |
Good vs Bad Titles
# Good
feat: add user profile settings page
fix: prevent duplicate form submissions
refactor: extract authentication to middleware
# Bad
Update code
WIP
Fixes
John's changes
Pre-PR Checklist
Before creating PR:
Description Tips
Do:
- Lead with "why" not "what"
- Include testing instructions
- Note breaking changes
- Reference issues/tickets
- Add screenshots for UI changes
Don't:
- Create PR with failing tests
- Repeat the diff in prose
- Leave empty description
- Forget to mention risks
Linking Issues
## Summary
Implement user preferences dashboard.
Closes #123
Fixes #456
Related to #789
Draft PRs
Use drafts when:
- Work in progress
- Want early feedback
- CI needs to run first
gh pr create --draft --title "WIP: feature name"
PR Templates
Feature PR
## Summary
Add [feature] to allow users to [benefit].
## Changes
- Add [component/module]
- Update [existing code]
- Add [tests/docs]
## Testing
1. Navigate to [location]
2. Click [action]
3. Verify [expected behavior]
## Verification
- [x] Tests pass
- [x] Linting passes
- [ ] Manual testing done
## Checklist
- [ ] Tests added
- [ ] Documentation updated
- [ ] No console errors
Bug Fix PR
## Summary
Fix [bug] that caused [problem] when [condition].
## Root Cause
[Explanation of why the bug occurred]
## Solution
[How this PR fixes it]
## Testing
1. Previously: [reproduce bug]
2. Now: [verify fix]
3. Regression: [verify no side effects]
## Verification
- [x] Tests pass (including new regression test)
- [x] Bug no longer reproducible
Fixes #[issue-number]
Refactoring PR
## Summary
Refactor [area] to [improvement].
## Motivation
- [Why this refactoring is needed]
- [What problems it solves]
## Changes
- Extract [X] into [Y]
- Rename [A] to [B]
- Consolidate [duplicated code]
## Verification
- [x] All existing tests pass
- [x] No functional changes
- [x] Performance unchanged
## Notes
This is a pure refactoring with no behavioral changes.
See Also
