pr

Create a GitHub pull request from the current branch with a conventional-commits-based title and descriptive body.

7|Updated Dec 5, 2023

Search Tags:#automation #git #github #branch #pull-request #conventional-commits

Ready to run

npx skills add https://github.com/mParticle/aquarium --skill pr-mparticle

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pr
Source: https://github.com/mParticle/aquarium/tree/main/.claude/skills/pr
Command: npx skills add https://github.com/mParticle/aquarium --skill pr-mparticle

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates turning a local branch into a GitHub pull request with a clear, structured description derived from commits and diffs.

Core Features & Use Cases

Automated PR creation from the current branch with a standardized title and descriptive body.
Branch validation to ensure the current branch is not main, follows naming conventions, and is ahead of the base branch.
Template-aware PR generation that respects conventional-commits guidance and existing PR templates.

Quick Start

Create a pull request from the current branch with a well-structured description derived from commits and diffs.

Frequently Asked Questions about pr

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

FAQPage Schema

How do I create a GitHub pull request with a structured description from my current branch?▼

You can create a GitHub pull request by automating the generation of a structured description derived from your branch's commits and diffs. This automatically builds a conventional-commits-based title and a descriptive body, including the base branch and ticket references.

Can I automatically generate a PR body from conventional commits?▼

Yes, PR body generation automatically extracts commit history and diffs to construct a descriptive body. It respects conventional-commits guidance and existing PR templates to ensure the pull request follows repository conventions.

What is the best way to automate PR creation while ensuring branch validation?▼

Automated PR creation includes branch validation to ensure the current branch is not main, follows naming conventions, and is ahead of the base branch. This prevents invalid pull requests before automatically generating the title and descriptive body.

Does automated pull request creation work with the main branch as the default base?▼

Yes, automated pull request creation defaults the base branch to main. It validates that your current working branch is not main and is ahead of the base branch before generating the PR title and body.

How does template-aware PR generation work for feature branches?▼

Template-aware PR generation respects existing PR templates and conventional-commits guidance. It analyzes your feature branch's commits and diffs to populate the template, ensuring the resulting pull request matches repository conventions.

What happens if my current branch fails branch validation during automated PR creation?▼

If branch validation fails, automated PR creation stops because the current branch is either main, violates naming conventions, or is not ahead of the base branch. You must fix the branch state to proceed with generating the pull request.