pr-description_skill

This skill automatically analyzes your git changes to generate a comprehensive PR description and creates the PR via GitHub CLI.

Rust

4.6k

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill antinomyhq/forge --skill pr-description

SKILL.md11.0 KB

Overview

This skill generates clear, review-ready pull request descriptions and creates the PR using the GitHub CLI. It analyzes your branch, commit history, and diffs to explain what changed, why it matters, and how to test it. It writes the description to a temporary file, calls gh pr create, and returns the PR link and summary.

How this skill works

The skill inspects the current branch and verifies there are commits ahead of main or master. It collects commit messages, a diff summary, and representative code changes (sampling large diffs). It classifies the change (fix, feature, refactor, etc.), builds a structured markdown description (Summary, Context, Changes, Testing, Links), writes it to .forge/FORGE_PR_DESCRIPTION.md, runs gh pr create with that file, removes the temp file, and returns the PR URL, change type, and brief summary.

When to use it

You want an automated, structured PR description from commits and diffs.
You need to create a PR quickly from a feature or bug branch.
You want consistent PR formatting for reviewers.
You need testing steps included automatically.
You want to avoid empty or placeholder PR descriptions.

Best practices

Work on a topic branch with commits ahead of main/master before invoking the skill.
Keep commit messages descriptive to improve classification and summary quality.
If diffs are large, point reviewers at key files or add a short sampling note.
Include related issue numbers or documentation links in your branch or commit messages when available.
Review the generated description and adjust any project-specific details before submitting.

Example use cases

Create a PR for a new feature branch: generate summary, list changes, and include manual test steps.
Open a bug-fix PR that explains root cause, fix, and reproduction steps for QA.
Submit a refactor PR that describes intent, high-level approach, and why behavior is unchanged.
Make a small docs or test PR with a concise Summary and Testing section.
Create a performance improvement PR that highlights benchmarks and verification commands.

FAQ

You must be on a branch with commits ahead of origin/main (or origin/master). The gh CLI should be installed and authenticated.

How does it handle very large diffs?

For large diffs it samples the most meaningful files and produces a high-level summary rather than pasting the full diff; it can reference key files or tests for reviewers.