# PR review format

Use for a multi-file review artifact where the reviewer needs reading order, focus questions, and source files.

## Great instance

- Ships a folder, not one pasted mega-document.
- Uses `README.md` as the review route and places source files beside it.
- Orders files by comprehension, not by diff order.
- Gives each file a small set of resolvable focus questions.

## Cut

- Full diff dumps in the README.
- Vague prompts like "review this carefully."
- Links to files that are not shipped in the folder.

## Skeleton

```markdown
# PR review: <change>

## Review goal
<what decision the reviewer should reach>

## Reading order
1. `<path>` - <why first>; focus: <question>
2. `<path>` - <why next>; focus: <question>

## Cross-cutting risks
- <risk or invariant to check>

## Done means
- <specific approval or change request condition>
```

## Section prompts

- Create `README.md` plus the actual source files under the same folder.
- Keep each focus question as one list item.
- Point reviewers at exact files, then let the code viewer carry line anchors.
- Include tests or fixtures when they are part of the review target.

## Renderer moves

Catalog: ../building-artifacts.md#what-each-file-type-becomes - folder browser; code line anchors.
