Get the FREE Ultimate OpenClaw Setup Guide →

pr-workflow

npx machina-cli add skill fcakyon/claude-codex-settings/pr-workflow --openclaw
Files (1)
SKILL.md
2.2 KB

Pull Request Workflow

Complete workflow for creating pull requests following project standards.

Process

  1. Verify staged changes exist with git diff --cached --name-only

  2. Branch setup

    • If on main/master, create feature branch first: feature/brief-description or fix/brief-description
    • Use github-dev:commit-creator subagent to handle staged changes if needed
  3. Documentation check

    • Update README.md or docs based on changes compared to target branch
    • For config/API changes, use mcp__tavily__tavily_search to verify info and include sources
  4. Analyze all commits

    • Use git diff <base-branch>...HEAD to review complete changeset
    • PR message must describe all commits, not just latest
    • Focus on what changed from reviewer perspective
  5. Create PR

    • Use /pr-creator agent or gh pr create with parameters:
      • -t (title): Start with capital letter, use verb, NO "fix:" or "feat:" prefix
      • -b (body): Brief summary + bullet points with inline markdown links
      • -a @me (self-assign)
      • -r <reviewer>: Find via gh pr list --repo <owner>/<repo> --author @me --limit 5
  6. PR Body Guidelines

    • Single section, no headers if possible. Very concise
    • Few bullet points + 1 CLI/usage snippet or simple before/after snippet
    • No test plans, no changed file lists, no line-number links

Examples

CLI snippet:

Add compare command for side-by-side model comparison

- Run multiple models on same images with `--models` and `--phrases` flags
- Horizontal panel concatenation with model name headers

`ultrannotate compare --source ./images --models sam3.pt,yoloe-26x-seg.pt --phrases "person,car"`

Before/after:

Inline single-use variables in compare_models

- xyxy2xywhn handles empty arrays, guard unnecessary
- Use function reference for draw dispatch

Before: `boxes = result.get(...); ops.xyxy2xywhn(boxes, ...)`
After: `ops.xyxy2xywhn(result.get(...), ...)`

Source

git clone https://github.com/fcakyon/claude-codex-settings/blob/main/plugins/github-dev/skills/pr-workflow/SKILL.mdView on GitHub

Overview

This skill provides a complete pull request workflow aligned to project standards. It guides verifying staged changes, branching when needed, updating docs, analyzing the full commit set, and creating PRs with a structured title and concise body.

How This Skill Works

The workflow checks for staged changes with git diff --cached --name-only, ensures a feature or fix branch if you’re on main or master, prompts documentation updates, reviews all commits with git diff base-branch...HEAD, and creates the PR using gh pr create or the /pr-creator agent with a title that starts with a capital verb and a concise body containing bullet points and links.

When to Use It

  • When asked to create a PR for a new feature or fix
  • When changes require documentation updates
  • When the current branch is main/master and a feature branch should be created
  • When you want a reviewer assigned and a self-mention on the PR
  • When you want to ensure the PR description covers all commits

Quick Start

  1. Step 1: Verify staged changes: git diff --cached --name-only
  2. Step 2: If on main/master, create a feature or fix branch: feature/brief-description or fix/brief-description
  3. Step 3: Create the PR via /pr-creator or gh pr create with -t and -b, plus -a @me and -r <reviewer>

Best Practices

  • Verify staged changes with git diff --cached --name-only before PR
  • If on main/master, create feature/brief-description or fix/brief-description first
  • Update README.md or relevant docs based on changes; verify config/API notes with sources if applicable
  • Review all commits with git diff <base-branch>...HEAD and ensure the PR message describes all changes from reviewer perspective
  • Craft a concise PR body with bullet points, an inline usage snippet, and deploy to gh pr create or /pr-creator; self-assign and pick a reviewer

Example Use Cases

  • Create a PR for a new feature on feature/branch after implementing the code, with a title like Add login flow and a body describing changes
  • PR includes documentation updates in README and API docs to reflect the change
  • Open PR using gh pr create with -t and -b, self-assign, and specify a reviewer
  • If working on main, first create feature/brief-description branch to avoid direct main commits
  • Use the /pr-creator agent to publish the PR with a concise body and bullet points

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers