create-draft-pr

Create draft pull requests with GitHub CLI and PR templates.

Updated Mar 17, 2023
One-click install
npx skills add https://github.com/IainMcl/dotfiles --skill create-draft-pr-iainmcl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-draft-pr
Source: https://github.com/IainMcl/dotfiles/tree/main/claude/skills/create-draft-pr
Command: npx skills add https://github.com/IainMcl/dotfiles --skill create-draft-pr-iainmcl

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of draft pull requests, streamlining the code review process and ensuring essential information is included.

Core Features & Use Cases

  • Draft PR Creation: Uses the gh CLI to create draft pull requests.
  • Template Integration: Identifies and utilizes PR templates for consistent descriptions.
  • Information Inclusion: Guides on what to include (migrations, post-deployment steps) and what to exclude (file diffs, CI details).
  • Screenshot Handling: Provides instructions for capturing and referencing frontend change screenshots.
  • Use Case: When you've completed a feature, use this skill to quickly create a draft PR, ensuring all necessary details and visual aids are included for your reviewers.

Quick Start

Use the create-draft-pr skill to create a draft pull request with the title "feat: Add user authentication" and the body "This PR implements user authentication using OAuth2.".

Frequently Asked Questions about create-draft-pr

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

FAQPage Schema
How do I create a draft pull request using the GitHub CLI?

To create a draft pull request using the GitHub CLI, you need to execute the `gh` command with specific parameters for the title and body. This automation uses the CLI to identify PR templates and populate the description with necessary deployment details.

What should be included in a draft PR description for code review?

A draft PR description should include relevant information like database migrations and post-deployment steps. It should utilize PR templates for consistent descriptions while excluding file diffs and CI details to keep the submission focused for reviewers.

How do I add frontend change screenshots to a GitHub pull request?

To add frontend change screenshots to a GitHub pull request, you must capture the visual changes and reference them in the PR body. This ensures visual aids are included alongside the template text for your reviewers.

Can I automate pull request creation to match existing repository templates?

Yes, you can automate pull request creation to match existing repository templates. This skill identifies PR templates within the repository and incorporates them automatically to ensure the generated draft PR follows consistent formatting standards.

Why exclude file diffs and CI details from an automated draft PR?

Excluding file diffs and CI details from an automated draft PR prevents information overload. This approach keeps the PR description focused on essential information like database migrations and post-deployment steps, streamlining the code review process.