skills.rest
BfdCampos
BfdCamposCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

pr-description

Generate structured pull request descriptions with summary, goals, changes, testing, and Mermaid diagrams.

1|Updated Nov 15, 2022
Search Tags:#workflow#documentation#mermaid#diagrams#code-review#pull-request#pr-description
One-click install
npx skills add https://github.com/BfdCampos/dotfiles --skill pr-description-bfdcampos
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/BfdCampos/dotfiles/tree/main/claude/skills/pr-description
Command: npx skills add https://github.com/BfdCampos/dotfiles --skill pr-description-bfdcampos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide helps teams craft comprehensive PR descriptions that accelerate code reviews by clearly communicating changes, rationale, and potential impacts.

Core Features & Use Cases

  • Structured PR sections (Summary, Goals, Changes, Testing, Notes, and Future Work) to standardize reviews.
  • Visual diagrams (Mermaid-based Data Flow Diagram and Entity Relationship Diagram) to illustrate data flow and relationships.
  • Practical templates and examples to speed up writing and ensure consistency across projects.

Quick Start

Create a new PR description by following the sections and diagrams outlined above.

Frequently Asked Questions about pr-description

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a pull request description that helps reviewers understand code changes quickly?▼

Standardizing pull request descriptions with structured sections like Summary, Goals, Changes, and Testing helps reviewers understand changes quickly. Including Mermaid diagrams for data flow and ERD provides visual context for complex updates.

What is the best way to structure a PR description for consistent code reviews?▼

Standardizing PR descriptions with defined sections like Summary, Goals, Changes, Testing, and Notes ensures consistent code reviews. Adding Future Work sections provides context for downstream tasks while maintaining review consistency across software projects.

How do I add Mermaid diagrams to a pull request description?▼

Adding Mermaid diagrams to PR descriptions involves generating Data Flow Diagrams and Entity Relationship Diagrams. These visual Mermaid blocks illustrate data flow and entity relationships directly within the pull request documentation for reviewer context.

Can I include data flow and ERD diagrams in my code review workflow?▼

Including data flow and ERD diagrams in a code review workflow involves embedding Mermaid syntax into PR descriptions. These diagrams visually map data flow and entity relationships, helping reviewers grasp architectural changes during code review.

Does a structured PR template speed up the code review process?▼

Using a structured PR template with defined Summary, Goals, Changes, and Testing sections speeds up code reviews. Standardized documentation reduces ambiguity, enabling reviewers to assess pull requests efficiently without extensive context gathering.

Related Skills

Explore More Software Engineering Skills→
JsplixJsplix

code-review-pr-body

Generate structured pull request body drafts from git diffs.

Community
Intermediate
dmzoneilldmzoneill
2

dev-workflow-orchestrator

Route developer requests to specialized sub-skills for workflow tasks.

Community
Advanced
nrhys2005nrhys2005

review

Generate and execute pytest tests for git repository code changes.

Community
Intermediate
vinvcnvinvcn
23

documentation-and-adrs

Create architectural decision records using structured Markdown templates.

Community
Intermediate