PR Description Writing
Guides the creation of clear, concise, and user-centric pull request descriptions.
The source repository doesn't declare a license. Check its terms before reusing the code.
Key features
- Enforces structural requirements like dependency callouts and mandatory screen recordings for UI changes.
- Promotes a narrative, tutorial-style format for validation steps (e.g., 'Expect to see...').
- Provides a clear list of anti-patterns, such as avoiding technical jargon and overly long descriptions.
- Defines a 'Voice Guide' focused on user-centricity and respect for reviewer time.
- Includes a step-by-step workflow from gathering changes to creating a draft PR via CLI commands.
Use cases
- Drafting a new pull request for a feature or bug fix.
- Updating the description of an existing pull request to improve clarity.
- Onboarding new developers to a team's pull request standards.
FAQ
How does this skill improve my development workflow?
It streamlines PR creation with checklists and CLI command examples, reduces back-and-forth during code reviews by improving clarity, and ultimately helps get your code approved and merged faster.
What key capabilities does it provide?
It enforces structural rules like dependency callouts and screen recordings for UI changes, provides a tutorial-style format for validation steps, and defines clear anti-patterns, such as avoiding jargon and overly long descriptions.
What does the PR Description Writing skill do?
This skill guides you to write clear, concise, and user-centric pull request descriptions. It provides a structured process and a 'Voice Guide' focused on respecting reviewer time and making validation easy.
When should I use this skill?
You should use this skill every time you create or update a pull request using Claude. It's especially valuable for PRs with UI changes (which require screen recordings), complex logic, or dependencies on other PRs.