nsheaps/request-a-review

Requesting a Review

Create and maintain pull requests for feature branches using gh api with --hostname github.com (required for web sessions where the git remote is a local proxy).

Pre-fetched Context

Current branch: !git branch --show-current 2>/dev/null || echo "(not in a git repo)"

Prerequisites

eval "$(mise activate bash)"

The gh CLI must be available (installed via mise) and GH_TOKEN must be set in the environment.

Step 1: Check for Existing PR

Always check before creating to avoid duplicates. Use server-side filtering:

gh api "repos/nsheaps/ai-mktpl/pulls?head=nsheaps:<branch-name>&state=open" \
  --hostname github.com \
  --jq '.[0] | {number, title, state}'

If a PR already exists, skip to Step 3: Update PR.

Step 2: Create Draft PR

PR_NUMBER=$(gh api repos/nsheaps/ai-mktpl/pulls \
  --hostname github.com \
  --method POST \
  --field title="Short descriptive title" \
  --field head="<branch-name>" \
  --field base="main" \
  --field draft=true \
  --field body="$(cat <<'PREOF'
## Summary
- What changed and why

## Test plan
- [ ] Verification steps

<!-- Include Claude Code session link if available, e.g.: https://claude.ai/code/session_XXXXX -->
PREOF
)" --jq '.number')

Then add the request-review label to trigger AI code review:

gh api repos/nsheaps/ai-mktpl/issues/${PR_NUMBER}/labels \
  --hostname github.com \
  --method POST \
  --field 'labels[]=request-review'

Step 3: Update PR

After subsequent pushes, update the PR body to reflect all current changes:

gh api repos/nsheaps/ai-mktpl/pulls/<PR_NUMBER> \
  --hostname github.com \
  --method PATCH \
  --field body="$(cat <<'PREOF'
## Summary
- Updated description reflecting all changes

## Test plan
- [ ] Updated verification steps

<!-- session link -->
PREOF
)"

Step 4: Mark Ready (When Complete)

Only after review feedback is addressed and CI passes:

gh api repos/nsheaps/ai-mktpl/pulls/<PR_NUMBER> \
  --hostname github.com \
  --method PATCH \
  --field draft=false

PR Title Conventions

• Keep under 70 characters
• Start with a verb (Add, Fix, Update, Refactor, etc.)
• Match conventional commit style when applicable

PR Body Formatting

CRITICAL: PR bodies must contain real newlines, not literal \n escape sequences.

• When using gh api, use heredocs ($(cat <<'PREOF' ... PREOF)) — they preserve newlines naturally
• When using MCP tools (e.g. mcp__github__create_pull_request), pass the body as a multi-line string with actual newlines — MCP tool string parameters support real newlines
• Never construct PR bodies by concatenating strings with \n — GitHub renders them as literal text, not line breaks

Error Handling

| Error | Resolution | | --------------------- | ---------------------------------------------------- | | gh not found | Run eval "$(mise activate bash)" or mise install | | 401 Unauthorized | Check GH_TOKEN is set and has PR write scope | | 422 Validation failed | Branch may not exist on remote yet — push first | | PR already exists | Use PATCH to update instead of POST to create |