pr-description

Generate concise GitHub PR descriptions from commits and diffs.

14.0k|2.4k|Updated Dec 27, 2023
One-click install
npx skills add https://github.com/pipecat-ai/pipecat --skill pr-description-pipecat-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/pipecat-ai/pipecat/tree/main/.claude/skills/pr-description
Command: npx skills add https://github.com/pipecat-ai/pipecat --skill pr-description-pipecat-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Update a GitHub PR description automatically by generating a concise summary of the changes made in the PR, saving time for maintainers.

Core Features & Use Cases

  • Automatic PR summaries: Create a clear, readable PR description from commits, diffs, and related references.
  • Consistency and references: Include issue references from --fixes or commit messages to ensure traceability.
  • Use Case: When preparing a PR for a large feature, this Skill produces a summary that helps reviewers quickly understand changes.

Quick Start

Use the /pr-description <PR_NUMBER> [--fixes <ISSUE_NUMBERS>] to update the PR description with a concise summary.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I automatically generate a GitHub PR description from commit history?

Use the pr-description Skill to analyze commits, diffs, and metadata, then generate a concise summary that updates your PR description automatically. It incorporates issue references from --fixes or commit messages for full traceability.

Can I include issue references when summarizing pull request changes?

Yes. The pr-description Skill extracts issue references from --fixes flags or commit messages and includes them in the generated summary, maintaining links between code changes and tracked issues.

What information does the PR summary pull from?

The Skill analyzes PR metadata, full commit history, file diffs, and repository data via the GitHub plugin and local git commands to create an accurate, detailed summary of all changes made.

How do I use pr-description to update a specific pull request?

Run /pr-description <PR_NUMBER> [--fixes <ISSUE_NUMBERS>] to generate and apply a concise summary to your PR. Optionally include issue numbers with --fixes to link related work.

What do reviewers gain from an auto-generated PR summary?

Reviewers quickly understand the scope and purpose of changes without reading raw diffs. A clear, structured summary saves review time and reduces misunderstandings about intent.