PR Guide

A worksheet for working with PRs, reviewing someone else’s or planning your own, in a way that builds lasting understanding instead of just relaying a coding agent’s output. Pick a branch and fill it out.

Flow

%%{init: {"themeVariables": {"fontSize": "12px"}}}%%
flowchart TD
    Start{Review or<br/>implement?}
    Start -->|Review| R0[Orient]
    Start -->|Implement| P0[Orient]

    R0 --> R1[My own read]
    R1 --> R2[Check vs agent]
    R2 --> R3[Review pass]
    R3 --> R4[My comments]
    R4 --> RT[Takeaway]

    P0 --> P1[My own plan]
    P1 --> P2[Check vs agent]
    P2 --> P3[Finalize]
    P3 --> PT[Takeaway]

Reviewing a PR

How long should Stage 1 take?

  • Small, mechanical diff (config change, one function, obvious bug fix): a few minutes.
  • Typical feature PR (a handful of files, some new logic): 15-30 minutes.
  • Core/shared code, data models, auth, or anything unfamiliar: 30-45+ minutes, and that’s fine.
  • Better than a timer: stop once you can state intent and approach in 2-3 sentences without looking anything up. If you can’t after a reasonable amount of time on a small diff, that’s a sign to ask the agent to orient you on the surrounding system first, not to push harder alone.

Implementing my own PR

How detailed should Stage 1 be?

  • Enough that a teammate could poke a hole in it, not enough that you’re writing pseudocode.
  • Name what changes and why, not how. If you’re writing function signatures or exact file edits, you’ve gone too deep for this stage.
  • If you can’t name which files/modules are involved at all, you haven’t gone deep enough yet, that’s a sign to go back to Stage 0.