| name | auto-pr |
| description | Automated PR submission assistant, including code review, documentation generation, and PR creation |
Auto PR - Automated PR Submission Assistant
Overview
This skill helps you automate the complete Pull Request process, including code review, documentation generation, and PR creation.
Core Functions
- Update Base Branch - Sync remote main/master branch
- Code Review Analysis - Compare differences between current and base branch
- PR Template Discovery - Automatically scan for PR templates in the project
- English Documentation Generation - Generate English PR description, waiting for user confirmation
- Automatic PR Submission - Create PR using English description after user approval
- Cleanup Process - Offer to remove temporary PR description files after submission
Usage
/auto-pr [base-branch]
base-branch: Optional, defaults to main
Workflow
Please execute the following workflows in sequence:
- Branch Preparation ⭐⭐⭐
- Code Review ⭐⭐⭐
- Documentation Generation ⭐⭐⭐
- PR Submission ⭐⭐⭐
Key Interaction Points
During the documentation generation phase, the process will pause to wait for user confirmation:
Branch Preparation → Code Review → Generate English Documentation → [Wait for User Confirmation] → Submit PR → [Clean Up Temporary Files]
User Confirmation Points:
- After English documentation is generated, wait for user review and confirmation
- After PR is submitted, confirm deletion of temporary description files (PR_DESCRIPTION.md, etc.)
Prerequisites
Environment Check
Before executing the skill, run the check script:
node ./scripts/check-prerequisites.js
Dependency Requirements
| Dependency | Required | Installation Method |
|---|
| Git | Yes | System built-in or brew install git |
| GitHub CLI | Yes | brew install gh |
| Node.js | Yes | brew install node |
GitHub CLI Authentication
Complete authentication for first use:
gh auth login
Select as prompted:
- GitHub.com
- HTTPS
- Use browser for authentication
After authentication, verify:
gh auth status
Project Requirements
Script Tools
This skill includes the following scripts:
| Script | Description |
|---|
scripts/check-prerequisites.js | Prerequisites check |
scripts/create-pr.js | Automatic PR creation |
Quick Start
node ./scripts/create-pr.js \
--title "feat: feature description" \
--body-file ./PR_DESCRIPTION.md
Notes
- Ensure all changes are committed before execution
- PR descriptions will automatically search for templates in the project
- Supports GitHub (requires gh CLI installation)
- Temporary description files will be offered for deletion after PR submission
