majiayu000/claude-skill-registry-data/pr-writing-majiayu000-claude-skill-registr
- community
Checking that the SKILL.md file is still in the repository.
Best practices for writing clear, effective pull request descriptions. Use when creating PRs to ensure they communicate changes effectively to reviewers.
Install
npx vskill@latest install majiayu000/claude-skill-registry-data/pr-writing-majiayu000-claude-skill-registrSKILL.md
PR Writing Skill
Guidelines for writing pull request descriptions that help reviewers understand and approve changes quickly.
PR Title Format
Always prefix the PR title with the GitHub issue number to enable easy cross-referencing.
Types
| Type | Use For | |
|---|---|---|
feat | New feature or functionality | |
fix | Bug fix | |
refactor | Code restructuring without behavior change | |
docs | Documentation only | |
test | Adding or updating tests | |
chore | Build, tooling, dependencies | |
perf | Performance improvement | |
style | Formatting, whitespace (no logic change) |
Good Titles
Bad Titles
PR Body Structure
Writing the Summary
Focus on WHY, not just WHAT
Bad:
Added a new function called validateEmail and updated the user model.
Good:
Adds email validation to prevent invalid emails from being stored, which was causing delivery failures in the notification system.
Be Specific About Impact
Bad:
Fixed authentication bug.
Good:
Fixes session timeout not being respected when "Remember Me" is checked, which was causing users to be logged out after 30 minutes regardless of their preference.
Keep It Scannable
Reviewers often skim. Front-load the important information:
Bad:
After investigating the issue that was reported last week about the dashboard loading slowly, I discovered that we were making redundant API calls. This PR addresses that by implementing caching.
Good:
Reduces dashboard load time by 60% by caching API responses. The redundant calls were causing 3-second delays on each page load.
Describing Changes
Be Specific and Organized
Group related changes:
Explain Non-Obvious Changes
Linking to Issues
Always link the related issue:
Or for partial work:
Highlighting Review Focus
Help reviewers prioritize their attention:
Screenshots and Visuals
For UI changes, always include:
For complex flows, use GIFs or numbered screenshots:
Breaking Changes
Clearly call out breaking changes:
Draft PRs
Use draft PRs for:
- Work in progress needing early feedback
- Architectural decisions to discuss
- Proof of concepts
Checklist Before Submitting
Before marking ready for review:
- [ ] Title follows
#<issue> type: descriptionformat - [ ] Summary explains what AND why
- [ ] Issue is linked with
Closes #X - [ ] Changes are listed specifically
- [ ] Tests are included and passing
- [ ] Screenshots added for UI changes
- [ ] Breaking changes are highlighted
- [ ] Self-reviewed the diff for obvious issues
- [ ] Branch is synced with main (no merge conflicts)
PR Size Guidelines
| Size | Lines Changed | Review Time | Recommendation | |
|---|---|---|---|---|
| Small | < 100 | < 30 min | Ideal | |
| Medium | 100-300 | 30-60 min | Acceptable | |
| Large | 300-500 | 1-2 hours | Consider splitting | |
| XL | > 500 | Hours | Split if possible |
If a PR is large, explain why:
Security
- Security scanPassed, 100 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingdevops/pr-writing-majiayu000-claude-skill-registr/SKILL.md
Popularity
- Repository stars
- 7
- Repository forks
- 4
- 7-day trend score
- 10
Stars and forks are for the whole GitHub repository, not this skill alone. Refreshed 14 May 2026, 5 months ago.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/majiayu000/claude-skill-registry-data/pr-writing-majiayu000-claude-skill-registr)