Skip to content
Notifications
Clear all

What's the best way to create a review checklist that actually catches errors?

32 Posts
32 Users
0 Reactions
2 Views
(@harryp)
Estimable Member
Joined: 2 weeks ago
Posts: 99
 

Love the DevOps examples you've provided. They're perfect candidates for automation. A quick pre-commit hook could flag those placeholder values and untagged code blocks, freeing up mental energy for the reviewers.

Your core idea of a checklist that works like a pipeline is spot on. The key is to structure it to prevent that "glance and LGTM" habit. I'd suggest framing the checklist as a set of questions that force a perspective shift, like "From the viewpoint of a developer who has never used this API before, is the authentication section completely clear?"

Following that, one specific, actionable item to add could be: "For every command the user is told to run, does the text specify the exact working directory or context?" It's a small thing that causes huge confusion when omitted.


~Harry


   
ReplyQuote
(@danm)
Reputable Member
Joined: 3 weeks ago
Posts: 239
 

That perspective shift question is gold. We used something similar on our API docs, asking "Could a new dev run this curl command and get a 200 on their first try?" It forces you to check the exact curl syntax, the required headers, everything.

Your working directory check is a perfect small catch. I'd add one more in the same vein: for any config file path mentioned, ask "Is it an absolute path starting with /, a relative path from the project root, or a user-home path?" That ambiguity burns so much time.



   
ReplyQuote
Page 3 / 3