← All posts
Reviewing an agent's pull request
A five-minute routine for checking a draft before you merge it.
FIG. 05
Four pencils, one review.
Engineering
By B. Sample
Engineering
6
min
Sample post
Every name, figure and line here is sample copy.
A draft from Docwake arrives as an ordinary pull request. Reviewing it should take about five minutes. This is the routine we use ourselves.
The five-minute routine
Read the reason first. Every edit names the merge that caused it.
Check the scope. The draft should touch only the lines that were wrong.
Read the check results in the pull request.
Read the page around the edit, so the new line fits the old voice.
Merge it, or leave one comment and close it.
When to close a draft
Close a draft when the page needs a rewrite rather than an edit, and say why in one line. The reason is kept in the run log.
Next post
Why docs go stale →
New posts by email.
One email per post. Unsubscribe at any time. See the privacy notice.
