| name | pr-formatting |
| description | Create and update pull request descriptions with comprehensive, well-structured content. Use when the user asks to create a PR, mentions "pull request" or "PR", wants to merge a branch, or needs to update an existing PR description. Invokes /git-actions:pr-write (create draft PR) or /git-actions:pr-edit (update PR) commands which analyze commits, generate structured descriptions with testing/deployment notes, and handle approval workflow. |
| allowed-tools | SlashCommand |
Creating and Updating Pull Requests
When the user needs to create or update a pull request, use the appropriate slash command. These commands orchestrate the workflow with best practices built-in.
Commands
Create New PR
/git-actions:pr-write # Target main (or master if main doesn't exist)
/git-actions:pr-write develop # Target specific branch
/git-actions:pr-write main focus on security changes # With custom guidance
What it does:
- Verifies not on base branch
- Pushes branch to remote (if needed)
- Analyzes all commits and changes
- Generates comprehensive PR description
- Presents for user approval
- Creates draft PR on GitHub (requires gh CLI)
Update Existing PR
/git-actions:pr-edit # Update current branch's PR
/git-actions:pr-edit 123 # Update specific PR by number
/git-actions:pr-edit 123 add performance metrics # With custom guidance
What it does:
- Fetches current PR description
- Analyzes commits and changes
- Generates updated description
- Presents for user approval
- Updates PR on GitHub
The pr-creator Agent
Both commands invoke the pr-creator agent, which has PR best practices embedded:
- Checks for repository PR template first (follows if exists)
- Generates clear, scannable structure
- Includes: Summary, Changes, Testing, Deployment Notes
- Organizes changes by component/area, not by file
- Provides comprehensive testing checklist
- Adapts to repository style
Custom Instructions
You can pass additional context to customize the output:
/git-actions:pr-write brief format
/git-actions:pr-edit 123 emphasize breaking changes
/git-actions:pr-write main focus on performance improvements
Draft Mode
All PRs are created in draft mode for review before publishing:
- Review the generated description
- Edit if needed:
/git-actions:pr-edit - Mark ready when satisfied:
gh pr ready
Examples
User: "I'm done with this feature, create a PR"
You: Use /git-actions:pr-write to create a draft PR with a comprehensive description.
User: "Create a PR to develop branch"
You: Use /git-actions:pr-write develop to target the develop branch instead of main.
User: "Update the PR description with the new changes"
You: Use /git-actions:pr-edit to regenerate the PR description based on current commits.
User: "The PR needs more emphasis on the security fixes"
You: Use /git-actions:pr-edit focus on security changes to update the description with security emphasis.