github-pr-enhance

Analyze GitHub PR diffs and generate enhanced descriptions with examples and diagrams.

1|Updated Jan 24, 2021
One-click install
npx skills add https://github.com/leighmcculloch/dotfiles --skill github-pr-enhance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: github-pr-enhance
Source: https://github.com/leighmcculloch/dotfiles/tree/main/files/claude/skills/github-pr-enhance
Command: npx skills add https://github.com/leighmcculloch/dotfiles --skill github-pr-enhance

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyzes an existing PR to ensure the description accurately reflects the implemented changes, then enriches it with context, examples, and diagrams.

Core Features & Use Cases

  • PR diff analysis to identify gaps between description and code changes.
  • Retrieve PR metadata (numbers, titles, URLs) and linked issues/PRs for comprehensive context.
  • Generate an enhanced, review-ready description with usage examples, diagrams, and suggested tests.

Quick Start

Run the PR enhancement workflow on the current branch to generate an enhanced description with examples and diagrams.

Frequently Asked Questions about github-pr-enhance

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

FAQPage Schema
How do I automate GitHub pull request description generation from code diffs?

Automate pull request description generation by analyzing code diffs to identify gaps between the existing description and actual changes. The process retrieves PR metadata, linked issues, and documentation references to produce an enhanced, review-ready description with usage examples and diagrams.

How do I check if my PR description matches the actual code changes?

Check PR description alignment by analyzing the diff data against the current PR body. This process identifies discrepancies between documented changes and implemented code, then enriches the description with missing context, linked issues, and generated diagrams.

Can I use GitHub CLI to analyze a specific pull request by number?

Yes, you can use GitHub CLI to analyze a specific pull request by providing a PR number or a repository and PR pair. The workflow gathers diffs, linked issues, and documentation references to generate an enhanced PR description.

What is the best way to add usage examples and diagrams to a PR body?

Add usage examples and diagrams to a PR body by running an automated enhancement workflow on the current branch. The workflow applies diff analysis and optional diagram generation capabilities to produce a review-ready description with suggested tests.

Do I need GitHub CLI installed to run automated PR analysis and enhancement?

Yes, GitHub CLI access is required to run automated PR analysis and enhancement. The workflow depends on gh CLI to retrieve PR bodies, diff data, linked issues, and metadata needed to generate an enriched description with examples and diagrams.