create-detail-pr

Automates GitHub pull requests with conventional commit titles and detailed descriptions.

Updated Oct 21, 2022
One-click install
npx skills add https://github.com/Chengxufeng1994/dotfiles --skill create-detail-pr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-detail-pr
Source: https://github.com/Chengxufeng1994/dotfiles/tree/main/claude/skills/create-detail-pr
Command: npx skills add https://github.com/Chengxufeng1994/dotfiles --skill create-detail-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of GitHub pull requests, ensuring they have properly formatted conventional commit titles and comprehensive, focused descriptions.

Core Features & Use Cases

  • Automated PR Creation: Generates pull requests with standardized titles and detailed bodies.
  • Contextual Analysis: Gathers information about default branches, commit history, and remote tracking to inform PR creation.
  • Conventional Commits: Enforces a structured title format (<type>(<scope>): <Summary>).
  • Detailed Body Generation: Creates a structured PR body including summary, changes, security improvements, testing information, impact/risks, and a checklist.
  • Use Case: After finishing a set of code changes, you can use this skill by saying "create a PR" to automatically generate a well-formatted pull request ready for review.

Quick Start

Use the create-detail-pr skill to create a pull request for your current branch.

Frequently Asked Questions about create-detail-pr

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

FAQPage Schema
How do I automate GitHub pull request creation with conventional commit titles?

You can automate GitHub pull request creation by using a skill that gathers your commit history and branch context to generate PRs with conventional commit titles and structured descriptions. It automatically analyzes your default branch and remote tracking status.

What should a detailed pull request description include for code review?

A detailed pull request description should include a summary, specific changes made, security improvements, testing information, impact and risks, and a review checklist. This structured body ensures reviewers have comprehensive context for evaluating the code changes.

How do I format conventional commit PR titles for my feature branch?

Conventional commit PR titles should follow the format `<type>(<scope>): <Summary>`. This skill enforces this structured title format automatically by analyzing your commit history and branch context to generate the appropriate type, scope, and summary.

Can I automatically generate a PR body from my git commit history?

Yes, you can automatically generate a PR body from git commit history. The skill gathers context from your commit history and remote tracking status to create a comprehensive body including summaries, changes, testing info, and checklists.

Does this automated PR generation work with my existing GitHub remote branches?

Yes, automated PR generation works with existing GitHub remote branches. The skill gathers context on your remote tracking status and default branches to ensure the generated pull request accurately reflects your repository's current state and configuration.

What is the best way to create structured GitHub pull requests after finishing code changes?

The best way to create structured GitHub pull requests after code changes is to automate the process. By triggering a skill like 'create a PR', it gathers your branch context and generates a well-formatted pull request with conventional titles and detailed sections ready for review.