Use this guide when you are asked to review a pull request for a teammate, a client or an open-source project and want to be helpful rather than nit-picky. Have the change, its description and any linked ticket open, plus the ability to run the code locally.
Step by step
Understand the purpose before reading the code
Read the pull request description and linked ticket first and write one sentence on what the change should achieve. If the description is missing or unclear, ask before reviewing, for example: "Could you add a line on what problem this solves and how you tested it? It will help me review properly." Reviewing code without knowing its goal leads to comments that miss the point.
The rest of this guide is for members
The rest of this guide – the remaining steps, a ready-to-use checklist, practical tips and fixes for common problems – is for members. Membership unlocks every ABCDayZ guide.
£3.99 for 1 month or £29 for 12 months. One payment, no automatic renewal.
Unlock all guidesAlready a member on another device? Open your personal access link. Bought Programming with AI? Your first month is included.