PR Review Slides
Workflow
Read the PR with
gh pr view <n>(add--repo <owner/repo>when you are not inside the repository) or the GitHub API. Record the title, draft state, base/head SHAs, head repo/ref, commit list, and changed-file stats.Check out the head branch locally; do not overwrite an existing same-name branch. Review the PR as-is, do not rebase it:
git fetch <remote> <head-ref> git switch -c pr-<n> <head-ref>Analyze the PR's own diff:
git diff <base-ref>...HEAD --stat, then read the hunks of every changed file. For each meaningful hunk, work out what it does, why it is written this way, and what a reviewer should watch.Build the deck in a working directory outside the repository, for example
~/pr-<n>-review-slides(reuse an existing Slidev project when one is available).Verify with
pnpm build, thenpnpm exec slidev --port 3031and open http://localhost:3031/.Do not push the slides into the repository. PR maintenance (rebase, push, description edits) is out of scope; only do it when the user asks for it separately.
Deck structure
- Cover and overview: title, draft state, base/head SHAs,
+/-stats, one-sentence summary. - Commit list with each commit's responsibility.
- Per-file sections: paste the actual
git diffhunks in```difffences, then explain what the code does, why it is written that way, line-by-line key points, and what changed relative to main. - Test plan and verification results that were actually run (commands, pass/fail, evidence paths).
- Review concerns and questions table: risks, gaps, follow-ups.
- References: PR link and file paths.
Slidev project gotchas
- Latest
@slidev/cliis52.x(no0.prefix).package.jsonneeds both@slidev/cliand@slidev/theme-default. - Set
mdc: falsein theslides.mdfrontmatter. Withmdc: true,{ ... }inside inline code is parsed as attributes and breaks rendering (InvalidCharacterError: Invalid qualified name). - Global CSS must live in
styles/index.css. A<style>block insideslides.mdis scoped to that slide only. - Keep dense slides readable: small fonts (body ~11.5px, code ~8.5px, tables ~9px),
pre { max-height: 38vh; overflow: auto }, andoverflow-y: autoon.slidev-layout. - Verify with
pnpm buildbefore serving, and watch the dev-server log for runtime errors.
Review quality
- Cover the whole PR diff, not just headline files.
- Redact secrets (API keys, tokens) in pasted evidence and logs.
- Separate PR-introduced issues from pre-existing ones by checking the same file on the base branch before claiming a regression.
- Flag stale descriptions (for example, files renamed or removed in the final branch) and correct the PR body if the user asks.