Agent skill

pr-description

Guide for creating comprehensive PR descriptions with proper structure, diagrams, and documentation for code reviews.

Stars 232
Forks 15

Install this agent skill to your Project

npx add-skill https://github.com/aiskillstore/marketplace/tree/main/skills/bfdcampos/pr-description

SKILL.md

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 for Reviewers

  • Pay attention to: [specific areas]
  • Assumptions made: [list any assumptions]
  • Dependencies: [any upstream/downstream impacts]

๐Ÿ”œ Future Work

  • Any follow-up tasks not included in this PR
  • Potential optimisations
  • Additional testing needed

## 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. **Keep it scannable**: Use headers, bullet points, and formatting

## Good Examples

### Good Summary
"This PR refactors the user authentication flow to use JWT tokens instead of session cookies. The change improves scalability for our microservices architecture and reduces server-side session storage requirements."

### Good Testing Description
```bash
# Commands run
npm run test:unit
npm run test:integration
npm run lint

Results:

  • โœ… 47 unit tests passed
  • โœ… 12 integration tests passed
  • โœ… No linting errors
  • โœ… Manual testing completed on staging environment

Error Handling

  • If unable to determine scope of changes, ask user for clarification
  • If testing hasn't been completed, remind user to run tests first
  • If no diagrams provided, create placeholder diagrams and ask user to review

Expand your agent's capabilities with these related and highly-rated skills.

aiskillstore/marketplace

perigon-backend

Perigon ASP.NET Core + EF Core + Aspire conventions

232 15
Explore
aiskillstore/marketplace

perigon-agent

Pointers for Copilot/agents to apply Perigon conventions

232 15
Explore
aiskillstore/marketplace

perigon-angular

Angular 21+ standalone/Material/signal conventions for Perigon WebApp

232 15
Explore
aiskillstore/marketplace

fastapi-mastery

Comprehensive FastAPI development skill covering REST API creation, routing, request/response handling, validation, authentication, database integration, middleware, and deployment. Use when working with FastAPI projects, building APIs, implementing CRUD operations, setting up authentication/authorization, integrating databases (SQL/NoSQL), adding middleware, handling WebSockets, or deploying FastAPI applications. Triggered by requests involving .py files with FastAPI code, API endpoint creation, Pydantic models, or FastAPI-specific features.

232 15
Explore
aiskillstore/marketplace

context7-efficient

Token-efficient library documentation fetcher using Context7 MCP with 86.8% token savings through intelligent shell pipeline filtering. Fetches code examples, API references, and best practices for JavaScript, Python, Go, Rust, and other libraries. Use when users ask about library documentation, need code examples, want API usage patterns, are learning a new framework, need syntax reference, or troubleshooting with library-specific information. Triggers include questions like "Show me React hooks", "How do I use Prisma", "What's the Next.js routing syntax", or any request for library/framework documentation.

232 15
Explore
aiskillstore/marketplace

browser-use

Browser automation using Playwright MCP. Navigate websites, fill forms, click elements, take screenshots, and extract data. Use when tasks require web browsing, form submission, web scraping, UI testing, or any browser interaction.

232 15
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results