gh-pr

Generate GitHub pull request descriptions from commit history and code changes.

3|Updated Nov 4, 2022
One-click install
npx skills add https://github.com/dousu/maou --skill gh-pr-dousu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gh-pr
Source: https://github.com/dousu/maou/tree/main/.claude/skills/gh-pr
Command: npx skills add https://github.com/dousu/maou --skill gh-pr-dousu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of detailed GitHub pull requests, ensuring all necessary context and information is provided to reviewers, thereby streamlining the code review process.

Core Features & Use Cases

  • Automated PR Description Generation: Intelligently crafts PR bodies based on commit history and code changes.
  • Comprehensive Review Guidance: Includes sections for problem, solution, impact, testing, and reviewer focus.
  • Use Case: When submitting a complex feature that touches multiple parts of the codebase, use this Skill to generate a PR description that clearly outlines the problem, the implemented solution, potential impacts, and specific areas for the reviewer to focus on.

Quick Start

Use the gh-pr skill to create a pull request with a title 'feat(api): add user authentication endpoint' and a detailed body.

Frequently Asked Questions about gh-pr

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

FAQPage Schema
How do I automate GitHub pull request creation from commit history?

Automating GitHub pull request creation involves analyzing commit history and code changes to generate detailed PR descriptions automatically. This streamlines the code review process by structuring problem statements, solutions, and impact analysis.

What is the best way to generate detailed PR descriptions for code reviews?

Generating detailed PR descriptions for code reviews is best handled by automating the extraction of context from conventional commit messages and code diffs. This provides structured sections for reviewer focus, testing strategies, and impact analysis.

Do I need the GitHub CLI to automate pull request generation?

Yes, you need the GitHub CLI (gh) to automate pull request generation. The CLI acts as the underlying interface for creating the pull requests, while the skill analyzes your commits to build the comprehensive description.

How do conventional commit messages improve automated PR descriptions?

Conventional commit messages improve automated PR descriptions by providing structured, parseable data about code changes. This allows the automation to accurately determine the problem, solution, and impact sections for the final pull request body.

What should be included in a comprehensive GitHub pull request body?

A comprehensive GitHub pull request body should include sections for the problem statement, the implemented solution, potential impact analysis, testing strategies, and specific areas for the reviewer to focus on during the code review.

Can I use this to create PRs for complex features touching multiple files?

Yes, you can use this to create PRs for complex features touching multiple files. The automation analyzes the full commit history and code changes across the codebase to generate a structured description outlining the problem and solution.