review-pr
Worktrunk PR Review
Review a pull request to worktrunk, a Rust CLI tool for managing git worktrees.
PR to review: $ARGUMENTS
Workflow
Follow these steps in order.
1. Pre-flight checks
Before reading the diff, run cheap checks to avoid redundant work. Shell state
doesn't persist between tool calls — re-derive REPO in each bash invocation or
combine commands.
REPO=$(gh repo view --json nameWithOwner --jq '.nameWithOwner')
BOT_LOGIN=$(gh api user --jq '.login')
HEAD_SHA=$(gh pr view <number> --json commits --jq '.commits[-1].oid')
PR_AUTHOR=$(gh pr view <number> --json author --jq '.author.login')
# Find the bot's most recent substantive review (any state).
# Include reviews with a non-empty body OR approvals (LGTM uses --approve -b "").
# Uses "| length > 0" instead of "!= \"\"" to avoid bash ! history expansion.
# IMPORTANT: `gh pr view --json reviews` returns `.commit.oid` (NOT `.commit_id`).
# The REST API (`gh api .../reviews`) uses `.commit_id` — don't confuse the two.
LAST_REVIEW_SHA=$(gh pr view <number> --json reviews \
--jq "[.reviews[] | select(.author.login == \"$BOT_LOGIN\" and (.body | length > 0 or .state == \"APPROVED\"))] | last | .commit.oid // empty")
If LAST_REVIEW_SHA == HEAD_SHA, this commit has already been reviewed — exit
silently. The only exception: an unanswered conversation question directed at
the bot (check below).
If the bot reviewed a previous commit (LAST_REVIEW_SHA exists but differs from
HEAD_SHA), check the incremental changes:
REPO=$(gh repo view --json nameWithOwner --jq '.nameWithOwner')
gh api "repos/$REPO/compare/$LAST_REVIEW_SHA...$HEAD_SHA" \
--jq '{total: ([.files[] | .additions + .deletions] | add), files: [.files[] | "\(.filename)\t+\(.additions)/-\(.deletions)"]}'
If the incremental changes are trivial, skip the full review and do not submit a new approval — the existing review stands. Go directly to step 6 to resolve any bot threads addressed by the new changes, then exit. Do NOT proceed to steps 2, 3, or 4. Rough heuristic: changes under ~20 added+deleted lines that don't introduce new functions, types, or control flow are typically trivial.
Then read all previous bot feedback and conversation:
REPO=$(gh repo view --json nameWithOwner --jq '.nameWithOwner')
BOT_LOGIN=$(gh api user --jq '.login')
# Previous review bodies
gh api "repos/$REPO/pulls/<number>/reviews" \
--jq ".[] | select(.user.login == \"$BOT_LOGIN\" and (.body | length > 0)) | {state, body}"
# Inline review comments
gh api "repos/$REPO/pulls/<number>/comments" --paginate \
--jq ".[] | select(.user.login == \"$BOT_LOGIN\") | {path, line, body}"
# Conversation (catch questions directed at the bot)
gh api "repos/$REPO/issues/<number>/comments" --paginate \
--jq '.[] | {author: .user.login, body: .body}'
Do not repeat any point from previous reviews — cross-reference previous bot
comments before posting inline comments. When concurrent runs race (a new push
while the first run is still responding), both see the same unanswered
question — check whether a bot reply exists after the question's timestamp
before answering. Address unanswered questions in the review body (not via
gh pr comment).
2. Read and understand the change
- Read the PR diff with
gh pr diff <number>. - Before going deeper, look at the PR as a reader would — not just the code, but the shape: what files are being added/changed, and does anything look off?
- Read the changed files in full (not just the diff) to understand context.
3. Review
Scale depth to the change. A docs-only PR or a mechanical rename needs a skim for correctness, not the full checklist. A new algorithm or state-management change needs trace analysis. Don't over-analyze trivial changes.
Idiomatic Rust and project conventions:
- Does the code follow Rust idioms? (Iterator chains over manual loops,
?over match-on-error, proper use of Option/Result, etc.) - Does it follow the project's conventions documented in CLAUDE.md? (Cmd for shell commands, error handling with anyhow, accessor naming conventions, etc.)
- Are there unnecessary allocations, clones, or owned types where borrows would suffice?
Code quality:
- Is the code clear and well-structured?
- Are there simpler ways to express the same logic?
- Does it avoid unnecessary complexity, feature flags, or compatibility layers?
Correctness:
- Are there edge cases that aren't handled?
- Could the changes break existing functionality?
- Are error messages helpful and consistent with the project style?
- Does new code use
.expect()or.unwrap()in functions returningResult? These should use?orbail!instead. - Trace failure paths, don't just note error handling exists. For code that
modifies state through multiple fallible steps, walk through what happens when
each
?fires. What has already been mutated? Is the system left in a recoverable state? Describing the author's approach ("ordered for safety") is not the same as verifying it.
Testing:
- Are the changes adequately tested?
- Do the tests follow the project's testing conventions (see tests/CLAUDE.md)?
Documentation accuracy:
When a PR changes behavior, check that related documentation still matches:
- Does
after_long_helpinsrc/cli/mod.rsandsrc/cli/config.rsstill describe what the code does? (These are the primary sources for doc pages.) - Do inline TOML comments in config examples match the actual behavior?
- If a new feature was added, does the relevant help text mention it?
Same pattern elsewhere:
When a PR fixes a bug or changes a pattern, search for the same pattern in other files. If found in the diff, add inline suggestions; if found outside the diff, offer to push a fix commit.
Duplication check (for new functions/types):
For every new public or module-level function added in the diff, search the codebase for existing functions that do the same thing. LLM-generated code frequently reinvents internal APIs — this is the highest-value check for externally contributed PRs.
Two search strategies, both required:
-
Similar names and signatures. Search for functions with similar names, return types, or parameter types:
# For a new `detect_pr_provider` function, search for existing detection rg "fn detect.*provider|fn get.*platform|fn .*_provider" --type rust -
Overlapping subgoals. Identify the intermediate steps the new code performs (e.g., iterating remotes, parsing URLs, resolving an org name) and search for existing code that does the same sub-tasks:
# New code iterates remotes and parses URLs — who else does that? rg "all_remote_urls|remote_url|GitRemoteUrl::parse" --type rust
Flag duplicates — reuse is almost always better than a parallel implementation.
4. Submit
If there are no issues, approve with an empty body — silence means correct.
gh pr review <number> --approve -b ""
If there are actionable findings, submit as a review with inline suggestions for concrete fixes. Every comment must give the author something to act on:
| Don't post (internal analysis) | Post (actionable) |
|---|---|
"The fix correctly delegates to default_config_path()" |
"The error hints still reference $XDG_CONFIG_HOME but the code uses etcetera now" |
| "The threshold logic is correct" | (nothing — silence means correct) |
"Good use of Iterator::scan here" |
"This .collect::<Vec<_>>() is only iterated once — can stay as an iterator" |
Don't explain what the code does — the author wrote it. Don't nitpick formatting — that's what linters are for. Explain why something should change, not just what.
Form your own opinion independently. Do not factor in other reviewers' comments or approvals when deciding whether to approve — the value of this review is as an uncorrelated signal.
When confidence is low, go beyond checking the implementation — question the approach: "Does this bypass or duplicate an existing API?" "What does this change not handle?" If the design involves a judgment call, flag it for human review as a COMMENT.
Self-authored PRs (PR_AUTHOR == BOT_LOGIN): Do NOT attempt
gh pr review --approve — GitHub rejects self-approvals. Submit as COMMENT
when there are concerns, or stay silent and skip to step 5.
Not confident enough to approve (unfamiliar module, subtle logic): Add a
+1 reaction instead — no review needed unless there are specific observations.
gh api "repos/$REPO/issues/<number>/reactions" -f content="+1"
Posting mechanics
Before posting, verify HEAD hasn't moved and no review was already posted for this commit:
REPO=$(gh repo view --json nameWithOwner --jq '.nameWithOwner')
BOT_LOGIN=$(gh api user --jq '.login')
CURRENT_HEAD=$(gh pr view <number> --json commits --jq '.commits[-1].oid')
[ "$CURRENT_HEAD" != "$HEAD_SHA" ] && echo "HEAD moved — skipping" && exit 0
# NOTE: REST API uses .commit_id (not .commit.oid from gh pr view --json)
ALREADY_POSTED=$(gh api "repos/$REPO/pulls/<number>/reviews" \
--jq "[.[] | select(.user.login == \"$BOT_LOGIN\" and .commit_id == \"$HEAD_SHA\")] | last | .submitted_at // empty")
[ -n "$ALREADY_POSTED" ] && echo "Already reviewed — skipping" && exit 0
Post exactly one review per run. Always give a verdict: approve or
comment (never "request changes"). Use gh pr review for reviews, not
gh pr comment. Note: --comment requires a non-empty body — if there's
nothing to say, use the approve-with-empty-body pattern.
Inline suggestions are mandatory for concrete fixes. Whenever there's a concrete fix (typos, doc updates, naming, missing imports, minor refactors), post it as an inline suggestion on the exact line — never as a code block in the review body. Inline suggestions let the author apply with one click; code blocks force them to find the line and copy-paste manually.
For fixes targeting lines outside the diff, offer to push a fix commit instead.
Post inline suggestions via the review API:
cat > /tmp/review-body.md << 'EOF'
Summary of suggestions
EOF
cat > /tmp/review-payload.json << 'ENDJSON'
{
"event": "COMMENT",
"comments": [
{
"path": ".claude/skills/example/SKILL.md",
"line": 3,
"body": "```suggestion\ndescription: new text here\n```"
}
]
}
ENDJSON
BODY=$(cat /tmp/review-body.md)
jq --arg body "$BODY" '.body = $body' /tmp/review-payload.json > /tmp/review-final.json
gh api "repos/$REPO/pulls/<number>/reviews" \
--method POST \
--input /tmp/review-final.json
Do not use -f 'comments[0][path]=...' flag syntax — gh api converts
array indices to object keys, which GitHub rejects.
- If a review has both suggestions and prose observations, put the suggestions as inline comments and the prose in the review body.
- Multi-line suggestions: set
start_lineandlineto define the range. Minimize the range — only include lines that actually need changing. A range that's too wide can delete correct code adjacent to the fix.
5. Monitor CI
After approving or staying silent, monitor CI using the approach from
/running-in-ci.
- All required checks passed → done.
- A check failed and it's related to the PR → post a follow-up COMMENT
review with analysis and inline suggestions, then dismiss the bot's approval:
Skip if already dismissed. Do not push fixes on human-authored PRs — post the analysis and offer to fix, then wait for the author to accept.# Use PUT, not POST — the dismiss endpoint requires it gh api "repos/$REPO/pulls/<number>/reviews/$REVIEW_ID/dismissals" \ -X PUT -f message="CI failed — <reason>"
6. Resolve handled suggestions
After submitting the review, check if any unresolved bot threads have been addressed by the new changes. Resolve threads where the suggestion was applied.
cat > /tmp/review-threads.graphql << 'GRAPHQL'
query($owner: String!, $repo: String!, $number: Int!) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $number) {
reviewThreads(first: 100) {
nodes {
id
isResolved
comments(first: 1) {
nodes {
author { login }
path
line
body
}
}
}
}
}
}
}
GRAPHQL
REPO=$(gh repo view --json nameWithOwner --jq '.nameWithOwner')
BOT_LOGIN=$(gh api user --jq '.login')
OWNER=$(echo "$REPO" | cut -d/ -f1)
NAME=$(echo "$REPO" | cut -d/ -f2)
gh api graphql -F query=@/tmp/review-threads.graphql \
-f owner="$OWNER" -f repo="$NAME" -F number=<number> \
| jq --arg bot "$BOT_LOGIN" '
.data.repository.pullRequest.reviewThreads.nodes[]
| select(.isResolved == false)
| select(.comments.nodes[0].author.login == $bot)
| {id, path: .comments.nodes[0].path, line: .comments.nodes[0].line, body: .comments.nodes[0].body}'
# Resolve a thread that has been addressed
cat > /tmp/resolve-thread.graphql << 'GRAPHQL'
mutation($threadId: ID!) {
resolveReviewThread(input: {threadId: $threadId}) {
thread { id }
}
}
GRAPHQL
gh api graphql -F query=@/tmp/resolve-thread.graphql -f threadId="THREAD_ID"
Outdated comments (null line) are best-effort — skip if the original context can't be located.
7. Push mechanical fixes
Bot PRs (Dependabot, renovate, etc.): If the review found concrete, fixable issues and there's no human author to act on feedback, commit and push the fix directly to the PR branch.
Human PRs: Post inline suggestions first. Additionally, offer to push a commit when the fixes are mechanical and correctness is obvious. Only push after the author accepts.
gh pr checkout <number>
git add <files>
git commit -m "fix: <description>
Co-Authored-By: Claude <noreply@anthropic.com>"
git push