github-pr-description

Generate pull request descriptions from git diffs and commit history.

7.5k|1.4k|Updated Dec 8, 2024
One-click install
npx skills add https://github.com/tailcallhq/forgecode --skill github-pr-description
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: github-pr-description
Source: https://github.com/tailcallhq/forgecode/tree/main/crates/forge_repo/src/skills/github-pr-description
Command: npx skills add https://github.com/tailcallhq/forgecode --skill github-pr-description

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generate pull request descriptions from code changes to streamline code reviews and improve clarity.

Core Features & Use Cases

  • Generate PR descriptions automatically when submitting changes via GitHub CLI
  • Analyze git diffs and commit history to produce meaningful, testable descriptions
  • Tailor descriptions to convey what changed, why it matters, and how to review

Quick Start

Generate a PR description for the current branch and use it when creating the PR with GitHub CLI.

Frequently Asked Questions about github-pr-description

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

FAQPage Schema
How do I auto-generate pull request descriptions from git diffs?

Auto-generating pull request descriptions from git diffs involves analyzing code changes and commit history to classify the change type and produce a meaningful summary. This process uses the GitHub CLI to directly create the PR with the generated text.

What is the best way to create PRs with GitHub CLI using commit history?

Creating PRs with GitHub CLI using commit history is best handled by automated tools that analyze your commit messages and code diffs. They synthesize this data into a structured description conveying what changed and why it matters before running the PR creation command.

Do I need GitHub CLI installed to generate PR descriptions from code changes?

Yes, you need GitHub CLI installed to generate PR descriptions from code changes through this automated workflow. The process implements prerequisites verification and ultimately executes PR creation via the GitHub CLI.

Can I automatically classify the change type when generating a PR description?

Yes, you can automatically classify the change type when generating a PR description. The mechanism analyzes git diffs and commit history to determine an appropriate change type and tailors the description to convey what changed and how to review it.

What should a generated pull request description include for effective code review?

A generated pull request description should include details on what changed, why it matters, and how to review it. By analyzing git diffs and commit history, the output provides meaningful, testable descriptions that streamline code reviews and improve clarity.