PR Review HTML

Overview

Produce a browser-readable review artifact that combines real diff excerpts, inline margin annotations, severity-coded findings, and a focused concept explanation for the code paths the user is least comfortable reviewing.

The HTML artifact is the human-facing deliverable. Keep source evidence, commands, and uncertainty visible so the artifact is reviewable rather than decorative.

Workflow

1. Identify the PR source: GitHub PR, local branch, patch file, or provided diff. If the target is ambiguous, ask for the PR number, branch, or diff.
2. Collect the actual diff with the best available source, for example gh pr diff <id>, git diff <base>...<head>, or the provided patch. Do not recreate the diff from memory.
3. Inspect the surrounding code needed to understand the changed behavior. Follow imports, call sites, tests, and ownership boundaries before writing findings.
4. If the user names a focus area, make it the review lens. For streaming, backpressure, cancellation, retries, async iteration, or queueing, load references/review-lenses.md.
5. Run only relevant validation commands that fit the repo and review scope. If validation is skipped, state why in the artifact.
6. Build a single .html file from assets/pr-review-artifact-template.html or an equivalent self-contained structure.
7. Open or sanity-check the artifact when feasible. For complex layouts, use browser automation or a screenshot check if available.

Artifact Contract