skills.rest
ic-facet
ic-facetOFFICIAL
Explore all skills by this author →
WebsiteGitHub

github-pr

Generate GitHub Pull Requests with conventional commit messages and structured descriptions.

2|Updated Aug 2, 2023
Search Tags:#developer tools#code review#pull request#conventional commits#github#cli
One-click install
npx skills add https://github.com/ic-facet/gestion-programas-asignatura --skill github-pr-ic-facet
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: github-pr
Source: https://github.com/ic-facet/gestion-programas-asignatura/tree/main/.cursor/skills/github-pr
Command: npx skills add https://github.com/ic-facet/gestion-programas-asignatura --skill github-pr-ic-facet

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you create high-quality GitHub Pull Requests with conventional commit messages and well-structured descriptions, streamlining your code review process.

Core Features & Use Cases

  • Conventional Commits: Enforces a standardized format for commit messages (<type>(<scope>): <description>).
  • Structured PR Descriptions: Provides a template for clear and concise PR summaries, change logs, and testing information.
  • Efficient PR Creation: Offers command-line examples using gh CLI for various scenarios, including draft PRs and adding reviewers.
  • Use Case: When you've finished a new feature, use this Skill to generate a PR title like feat(auth): implement two-factor authentication and a detailed body explaining the changes and how to test them.

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 write a conventional commit message for a GitHub pull request?▼

Conventional commit messages for a GitHub pull request follow the `<type>(<scope>): <description>` format, categorizing changes by type like `feat` or `fix` and scope to clarify the affected module. This standardizes commit history and streamlines code reviews.

How do I create a GitHub pull request using the gh CLI?▼

Create a GitHub pull request using the `gh CLI` by executing command-line examples for various scenarios like draft PRs, adding reviewers, and linking issues. This facilitates efficient PR creation directly from your terminal without navigating the web interface.

What should be included in a structured GitHub pull request description?▼

A structured GitHub pull request description should include sections for a summary, detailed changes, and testing information. This template ensures clarity during code reviews by explaining what was modified and how to validate the updates.

Can I add reviewers and link issues when creating a draft pull request?▼

Yes, you can add reviewers and link issues when creating a draft pull request by utilizing specific `gh CLI` command examples. This supports efficient PR creation by automating reviewer assignments and issue tracking directly from the command line.

Why use conventional commits for code reviews?▼

Use conventional commits for code reviews to enforce a standardized format for commit messages and PR titles, ensuring clarity. This structured approach helps reviewers quickly understand the type and scope of changes, streamlining the review process.

Does the github-pr skill work without external dependencies?▼

The github-pr skill operates without external dependencies, relying solely on the `gh CLI` to generate pull requests. It provides structured templates and command-line examples to facilitate code reviews without requiring additional software installations.

Related Skills

Explore More Software Engineering Skills→
pingwupingwu
12

github-cli

Automate GitHub repository management and Git operations from the terminal.

Community
Intermediate
DaFumDaFum
1

release-notes-synthesizer

Convert commit histories into Markdown release notes from Conventional Commits and PR descriptions.

Community
Advanced
HenquewlHenquewl
7

finishing-a-development-branch

Verify test suites and finalize git development branches through merge or cleanup.

Community
Advanced
channingwaltonchanningwalton
3

Code Reviewer

Automate code review across files, diffs, and repositories with severity-ranked findings.

Community
Basic