Agent skill · writing content · aiskillstore
pr-description
Guide for creating comprehensive PR descriptions with proper structure, diagrams, and documentation for code reviews.
Why this skill is useful
Codifies a structured approach for PR descriptions that helps standardize documentation practices.
What it needs
About 2k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
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: prdescription<descriptivetitle><timestamp>.md Get timestamp: date +"%Y%m%d%H%M%S" Example: prdescriptionuserauthrefactor20250612152832.md Required Structure bash List exact commands used for testing npm test npm run lint Mermaid Diagrams Use the mermaid skill for diagram syntax and styling that works in both light and dark mode. Data Flow Diagram Show the complete flow of data or logic: Input sources Processing steps Output destinations Include a colour-coded legend Entity Relationship Diagram (When Applicable) Show object/data relationships: Primary keys (PK) Foreign keys (FK) Relationship cardinality (one-to-many, many-to-many) Content Guidelines Summary Section Explain business context briefly Highlight key benefits Keep it to 2-3 sentences Changes Section Focus on what matters to reviewers Group related changes together Note any breaking changes prominently Testing Section ALWAYS include exact commands run Show evidence of successful tests Include validation results Add screenshots when helpful Future Work Section List intentionally deferred items Suggest optimisations or enhancements Note any technical debt created Key Principles 1. Be specific: Include exact commands, concrete examples 2. Show evidence: Screenshots, command outputs, test results 3. Think reviewer-first: What would a reviewer need to understand the changes? 4. Business context: Explain the "why" not just the "what" 5. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/pr-description