Chapter 12: Review

Making work reviewable

Doing the work so a reviewer can check it cheaply: one idea per pull request, a description saying what changed and why, and pasted evidence that it works, with the output of what you ran. You spend your time to save theirs.

When reading is the bottleneck, the most useful thing an author can do is make reading easier. An agent will happily write a description that claims everything worked. A description that pastes the output has to be true, or at least it can be checked.

Say it to your agent

“Write the pull request description with these headings: Why, What changed, How I checked. Under How I checked, paste the failing test output from before the fix and the passing output from after. Label anything you didn't run as not run.”

The workshop

Name a word, or describe what you mean in everyday language.