pr-description

Generate pull request titles and descriptions from git branch commits and diffs.

Updated Aug 14, 2012
One-click install
npx skills add https://github.com/dakotahp/dotfiles --skill pr-description-dakotahp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/dakotahp/dotfiles/tree/main/dot_config/claude/skills/pr-description
Command: npx skills add https://github.com/dakotahp/dotfiles --skill pr-description-dakotahp

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many pull requests lack a clear, reviewable description that explains why changes were made, what exactly changed, and how to verify them; this Skill automates composing a reviewer-friendly title and full description from the branch context so reviews are faster and more effective.

Core Features & Use Cases

  • Generates an imperative PR title and a comprehensive description that covers the why, what, and how for reviewers with little prior context.
  • Reads branch commits and diffs, detects and fills repository PR templates when present, and includes testing steps, migration notes, and risk/impact summaries.
  • Inserts ASCII or Mermaid diagrams where they add clarity and accepts optional contextual arguments (ticket numbers, intent, audience) to tailor phrasing and references.
  • Use case: a developer finishing a feature branch can run this to produce a ready-to-paste PR body that summarizes code changes, rationale, and test instructions.

Quick Start

Generate a pull request title and full description for the current branch and include the ticket number TICKET-123 as additional context.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I generate a pull request description from git commits?

To generate a pull request description from git commits, this Skill reads your branch commit history and diffs to automatically produce a reviewer-friendly title and a comprehensive body covering why, what, and how the changes were made.

Can I automatically fill repository PR templates when creating a pull request?

Yes, you can automatically fill repository PR templates when creating a pull request. The Skill inspects your repository for existing PR templates and automatically populates them with summarized code changes, rationale, and test instructions.

What is the best way to summarize code diffs for a code review?

The best way to summarize code diffs for a code review is to automate composing a full description from the branch context. This Skill analyzes diffs to produce testing steps, migration notes, and risk summaries so reviews are faster and more effective.

How do I add a Mermaid diagram to a pull request description?

To add a Mermaid diagram to a pull request description, this Skill automatically inserts ASCII or Mermaid diagrams where they add clarity. It generates these visual explanations from your branch commits and diffs to help reviewers understand complex changes.

Can I include ticket numbers and additional context when generating a PR title?

Yes, you can include ticket numbers and additional context when generating a PR title. The Skill accepts optional arguments like ticket numbers, intent, and audience to tailor phrasing and references within the generated pull request body.

Does this pull request generator work without external dependencies?

Yes, this pull request generator works without external dependencies. It operates directly on your local git repository to read commit history and diffs, requiring no additional components or external packages to produce PR descriptions.