review-pr_skill

This skill analyzes a given pull request in a read-only, deterministic way and produces structured review outputs for handoff.

TypeScript

196.5k

GitHub Stars

1

Bundled Files

1 month ago

Catalog Refreshed

3 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill openclaw/openclaw --skill review-pr

SKILL.md2.7 KB

Overview

This skill performs a script-first, read-only review of a GitHub pull request and produces both human- and machine-readable outputs for deterministic handoff to /prepare-pr. It enforces a strict execution contract, worktree isolation, and artifact validation to ensure reviews are reproducible and automatable. Use it to generate a structured review summary (.local/review.md) and a JSON findings file (.local/review.json).

How this skill works

The review runs through prescribed wrapper commands to set up a PR worktree, inspect the main baseline and the PR head, and produce scoped diffs from the merge-base. It never mutates the repository: all actions are performed in .worktrees/pr-<PR> and outputs live under .local. Before and after producing artifacts, automated guards and validators ensure the review meets the required shape and safety constraints.

When to use it

You need a deterministic, read-only PR review that feeds an automated prepare step.
When reviews must produce both human text and machine-readable findings for pipelines.
For PRs where merge-base scoped diffs are required to avoid stale-branch surprises.
When a reviewer must claim responsibility and record metadata without pushing changes.

Best practices

Always start by running scripts/pr-review <PR> so the worktree and metadata are initialized.
Use review-checkout-main and review-checkout-pr explicitly to compare baseline vs head.
Run scripts/pr review-guard <PR> before writing artifacts and again before finalizing.
Keep all review work under .worktrees/pr-<PR> and never delete the worktree from the review flow.
Validate .local/review.md and .local/review.json with scripts/pr review-validate-artifacts <PR> before finishing.

Example use cases

Automated reviewer for CI that must produce findings for downstream automated prepare and merge steps.
Human reviewer who needs a reproducible, auditable record of PR inspection and verdict.
Triage flow where multiple reviewers claim and annotate PRs without modifying branches.
Security or compliance checks that require read-only diff inspection scoped to merge-base.

FAQ

No. The review process is strictly read-only and operates only in the PR worktree; it will never push, merge, or alter branches.

What artifacts are produced?

Two artifacts: .local/review.md with sections A–J for human consumption, and .local/review.json containing structured findings, tests metadata, docs status, and a recommendation.

How do I ensure my review is valid?

Run scripts/pr review-guard <PR> before writing outputs and scripts/pr review-validate-artifacts <PR> afterwards; follow the execution contract precisely.