github-pr

Generate GitHub Pull Requests with conventional commit titles and detailed descriptions.

2|Updated Jun 11, 2024
One-click install
npx skills add https://github.com/gutierrezp22/administracion-departamentos --skill github-pr-gutierrezp22
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: github-pr
Source: https://github.com/gutierrezp22/administracion-departamentos/tree/main/.cursor/skills/github-pr
Command: npx skills add https://github.com/gutierrezp22/administracion-departamentos --skill github-pr-gutierrezp22

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation of high-quality GitHub Pull Requests, ensuring adherence to conventional commit standards and providing clear, informative descriptions.

Core Features & Use Cases

  • Conventional Commits: Enforces a structured format for PR titles and commit messages.
  • Detailed Descriptions: Guides the creation of comprehensive PR bodies including summaries, changes, and testing information.
  • Use Case: When you've completed a new feature, use this Skill to generate a PR title like feat(user): implement user profile page and a detailed description outlining the changes and testing steps.

Quick Start

Use the github-pr skill to create a pull request with the title "feat(api): add user endpoint" and a body describing the changes.

Frequently Asked Questions about github-pr

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

FAQPage Schema
How do I create a GitHub pull request that follows conventional commit standards?

Creating a GitHub pull request with conventional commit standards requires structuring your PR title with a type and scope, such as `feat(user): implement profile page`. This Skill automatically enforces that structured commit message format while generating detailed PR bodies.

What is a conventional commit format for a pull request title?

A conventional commit format for a pull request title prefixes the description with a type and optional scope, such as `feat(api): add user endpoint` or `fix(auth): resolve token expiry`. This structure clarifies the nature of changes for version control management.

Do I need the GitHub CLI installed to generate pull requests with conventional commits?

Yes, you need the GitHub CLI installed to generate pull requests using this Skill. It relies on the GitHub CLI to handle the software development workflow and execute the actual pull request creation from your command line interface.

What should be included in a detailed pull request description for code review?

A detailed pull request description for code review should include a summary of changes, specific modifications made, and testing information. This ensures reviewers understand the context, verify the implementation, and validate the testing steps performed.

Can I automate pull request creation and formatting directly from the command line?

You can automate pull request creation and formatting directly from the command line using the GitHub CLI. This Skill streamlines the process by automatically generating formatted conventional commit titles and comprehensive PR bodies for your software development workflow.

When should I use structured pull request titles in my software development workflow?

You should use structured pull request titles in your software development workflow whenever you complete a new feature or bug fix. Enforcing conventional commit standards during code review preparation maintains clear version control history and communicates changes effectively.