pr-description

Generate GitHub PR descriptions from commit messages and --fixes references.

Updated Apr 1, 2025
One-click install
npx skills add https://github.com/toinfinityai/pipecat --skill pr-description-toinfinityai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/toinfinityai/pipecat/tree/main/.claude/skills/pr-description
Command: npx skills add https://github.com/toinfinityai/pipecat --skill pr-description-toinfinityai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the process of updating GitHub PR descriptions to reflect the changes introduced in a PR, reducing manual editing and keeping summaries consistent.

Core Features & Use Cases

  • Generate a concise, publish-ready PR description from commit messages and diffs
  • Include referenced issues from the --fixes argument and from commit messages (e.g., Fixes #123)
  • Update existing descriptions when changes diverge from the original content
  • Suitable for cross-repo PRs and large feature work requiring clear changelogs

Quick Start

Run /pr-description <PR_NUMBER> to update the PR description with a summary of the changes.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I automatically update a GitHub PR description from commit messages?

You can automatically update a GitHub PR description by parsing commit summaries and diffs to generate a concise, publish-ready summary. This eliminates manual editing and ensures descriptions accurately reflect the changes introduced across repositories.

Can I include referenced issues in an auto-generated PR summary?

Yes, auto-generated PR summaries can include referenced issues. The process parses the --fixes argument and extracts commit message references like "Fixes #123" to ensure all linked issues are accurately documented in the final description.

What's the best way to keep PR descriptions consistent when changes diverge from the original content?

The best way to keep PR descriptions consistent is to automate updates based on git history. By analyzing commit messages and diffs, the description is regenerated to accurately reflect the current state of the pull request when changes diverge.

Does this approach work for cross-repo PRs and large feature work?

Yes, this approach works for cross-repo PRs and large feature work. It handles fixes references and commit summaries across repositories to generate clear changelogs, ensuring accurate and consistent PR descriptions for complex development scenarios.

How do I start automating GitHub PR description updates?

To start automating GitHub PR description updates, run the /pr-description command with the target PR number. This initiates the process of pulling PR data, parsing git history, and applying the generated summary directly to the pull request.