skills.rest
antinomyhq
antinomyhqOFFICIAL
Explore all skills by this author →
𝕏@forgecodehqGitHub

create-pr-description

Generate pull request descriptions from branch diffs and create PRs via GitHub CLI.

7.5k|1.4k|Updated Dec 8, 2024
Search Tags:#automation#github#generate#pull-request#gh-cli#pr-description
One-click install
npx skills add https://github.com/antinomyhq/forge --skill create-pr-description
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-pr-description
Source: https://github.com/antinomyhq/forge/tree/main/.forge/skills/pr-description
Command: npx skills add https://github.com/antinomyhq/forge --skill create-pr-description

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manual PR descriptions are time-consuming and may omit important context. This Skill automates the generation of thorough, well-structured PR descriptions to improve review quality and reduce back-and-forth.

Core Features & Use Cases

  • Automated PR Description: Generates a comprehensive description from diffs, commit messages, and changes.
  • PR Type Inference: Classifies PR as fix, feature, docs, or refactor and tailors the description accordingly.
  • Seamless PR Creation: Uses the GitHub CLI to create PRs with the generated description.
  • Use Case: When merging a feature branch, quickly produce a robust PR description including rationale and testing steps.

Quick Start

Run the pr-description skill to generate a PR description for the current branch and create the PR using GitHub CLI.

Frequently Asked Questions about create-pr-description

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

FAQPage Schema
How do I automatically generate a pull request description from git commits and diffs?▼

Automated pull request description generation analyzes your current branch diffs and commit messages to craft a structured PR summary. This skill infers the PR type, such as feature or fix, and builds a description with rationale, changes, and testing steps.

Can I create a GitHub pull request using the gh CLI with an auto-generated description?▼

Yes, you can create a GitHub pull request using gh CLI with an auto-generated description. This skill leverages the GitHub CLI to seamlessly open PRs, applying a structured summary derived from your branch diffs and commit history directly to the repository.

What is the best way to structure a PR description for different types of changes like features or fixes?▼

The best way to structure a PR description is to enforce a clear template covering summary, rationale, changes, tests, and links. This skill infers the PR type—whether fix, feature, docs, or refactor—and tailors the generated description to match the specific change context.

Do I need the GitHub CLI installed to automatically generate and open pull requests?▼

Yes, you need the GitHub CLI installed to automatically generate and open pull requests. This skill requires access to the GitHub CLI and your repository context to analyze branch diffs and directly create the PR on GitHub.

Why do my manual pull request descriptions lack context and cause review back-and-forth?▼

Manual PR descriptions often lack context because writing them is time-consuming and may omit important details. Automated PR generation solves this by extracting comprehensive context from diffs and commits, reducing review back-and-forth and improving overall review quality.

Related Skills

Explore More Software Engineering Skills→
cboonecboone
2

pr

Commit staged changes, push to remote, and create a GitHub pull request.

Community
Advanced
robinebersrobinebers
46

shepherd

Automate GitHub pull request review management until human approval.

Community
Advanced
viktorbezdekviktorbezdek
10

git-workflow

Automate Git commit formatting, branch organization, and release note generation.

Community
Advanced
jamesjlundinjamesjlundin
32

pr-review

Analyze pull requests and generate structured review reports.

Community
Intermediate