describe
Generate clear, professional PR descriptions based on code changes.
When & Why to Use This Skill
This Claude skill automates the creation of professional Pull Request (PR) descriptions by analyzing code changes. It solves the problem of inconsistent or vague documentation in the development workflow by generating structured summaries, clear titles, and impact assessments, ultimately accelerating the code review process and improving team collaboration.
Use Cases
- Automating documentation: Developers can instantly generate detailed PR descriptions from their commits, saving time on manual writing.
- Standardizing team communication: Engineering teams can ensure every pull request follows a consistent format (Background, Changes, Impact) for better project maintainability.
- Improving review efficiency: Reviewers can quickly grasp the scope and intent of changes through file-by-file summaries and categorized change types (e.g., bug_fix, feature).
- Onboarding and context sharing: Helps new team members or external contributors understand the 'why' behind code changes without needing deep prior knowledge of the specific task.
| name | describe |
|---|---|
| description | Generate clear, professional PR descriptions based on code changes. |
| version | 1.0.0 |
PR Description Skill
Task
Automatically generate clear, professional PR descriptions based on code changes.
Workflow
- Analyze Changes: Understand the purpose and scope of code changes
- Generate Title: Concise and clear, no more than 60 characters
- Categorize Type: feature, bug_fix, refactor, docs, test, chore
- Write Description: Include background, changes, impact scope
- File Summary: Change description for each file
Output Format
title: |
Concise PR title
type: "feature"
labels:
- "enhancement"
description: |
## Background
Why this change is needed
## Changes
What was done
## Impact
What features are affected
files:
- filename: "src/example.py"
change_type: "modified"
summary: "Added user validation logic"
Principles
- Title starts with a verb (Add, Fix, Update, Remove)
- Description should be understandable by those unfamiliar with the code
- File summary highlights key changes