← ClaudeAtlas

pr-descriptionlisted

Guide for creating comprehensive PR descriptions with proper structure, diagrams, and documentation for code reviews.
aiskillstore/marketplace · ★ 329 · Code & Development · score 79
Install: claude install-skill aiskillstore/marketplace
# PR Description Skill This skill provides a structured approach to creating comprehensive pull request descriptions that help reviewers understand changes quickly. ## When to Use Use this skill when: - Creating a new pull request - User asks to "create a PR description" or "write a PR description" - Documenting significant code changes for review ## File Creation (Optional) If saving the PR description to a file: - **Pattern**: `pr_description_<descriptive_title>_<timestamp>.md` - **Get timestamp**: `date +"%Y%m%d_%H%M%S"` - **Example**: `pr_description_user_auth_refactor_20250612_152832.md` ## Required Structure ```markdown # PR Title: [Descriptive Title] ## 📋 Summary Brief overview of what this PR accomplishes in 2-3 sentences. ## 📊 Data Flow Diagram [Mermaid diagram showing the flow/architecture - use `mermaid` skill for styling] ## 🗂️ Entity Relationship Diagram [Include if creating/modifying data relationships - Mermaid ERD] ## 🎯 Goals - Primary objective 1 - Primary objective 2 - Any secondary objectives ## 🔍 Changes in this PR - Description of key changes - Any config file changes - Schema modifications - Breaking changes (if any) ## 🧪 Testing ### Commands Run ```bash # List exact commands used for testing npm test npm run lint ``` ### Results - ✅ All tests passed - ✅ Linting passed - ✅ Build successful - Include any relevant screenshots or output ### Validation - Key scenarios tested - Edge cases covered - Performance considerations ## 📋 Notes