pr-preparer

Prepares and opens ready-for-review GitHub pull requests from completed branch changes.

Updated Nov 2, 2025
One-click install
npx skills add https://github.com/fx/skills --skill pr-preparer-fx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-preparer
Source: https://github.com/fx/skills/tree/main/skills/pr-preparer
Command: npx skills add https://github.com/fx/skills --skill pr-preparer-fx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Opening a pull request involves many easy-to-miss steps: verifying a clean working tree, auditing commits and branch naming, writing a conventional-commit title, crafting a concise description with a test plan, and updating task tracking documents. This Skill enforces all of these checks so PRs are consistent, compliant, and ready for review. ## Core Features & Use Cases - Branch and Commit Audit: Analyzes git diff main and git log to verify atomic commits, conventional commit messages, and semantic branch naming before opening the PR. - Blocking Title and Body Rules: Enforces conventional-commit PR titles (validated against a regex), forbids #N references and wave/phase numbers in titles, and requires a concrete checkbox test plan in the body. - Task Tracking Sync: Loads the project-management skill to mark completed tasks in docs/changes/ or docs/tasks.md, update change document status, and sync docs/index.yml and docs/index.md. - Use Case: After finishing a feature branch, invoke this Skill to validate the branch, generate a compliant PR title and description, create the PR with gh pr create (never as a draft), and hand off to CI monitoring. ## Quick Start Use the pr-preparer skill to review my current branch changes and open a ready-for-review pull request on GitHub.

Frequently Asked Questions about pr-preparer

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

FAQPage Schema
How do I create a pull request with the GitHub CLI?▼

Use `gh pr create --title "type(scope): description" --body "..."` after committing all changes. This Skill automates the full process: it audits the branch, enforces a conventional-commit title, writes a concise body with a test plan, and opens the PR ready for review.

What is a conventional commit PR title format?▼

A conventional commit title follows `type(scope): description`, such as `feat(auth): add OAuth2 login`, matching the regex `^(feat|fix|docs|refactor|chore|test|perf|build|ci|style|revert)(\(.+\))?!?: .+`. On squash-merge the title becomes the commit subject, so non-conventional titles pollute the history.

Why should PR titles not contain issue numbers like #123?▼

On squash-merge the PR title becomes the commit subject, where `#N` auto-links to that PR or issue. Using it for waves, phases, or change-doc numbers wrongly cross-links the commit, and GitHub already appends the real PR number automatically at merge time.

Can I open a draft pull request with this workflow?▼

No. All PRs must be created ready for review, never as drafts, because downstream steps like CI monitoring and reviewer adapters run from the moment the PR opens. If the work is not ready, finish it before opening the PR.

What happens if my working directory has uncommitted changes?▼

The Skill runs `git status --porcelain` first and stops immediately if any uncommitted changes exist. You must commit everything before it proceeds with branch analysis or PR creation.