Code Review Request Packager
By casey w · Published · Updated
Packages a change for a reviewer with its scope, the best place to start looking, how it was tested and the gaps you already know about.
Tags: coding, communication
Prompt template
## Code Review Request Packager Prepare this change for review so a reviewer can start in the right place. - Change summary: [textarea: What changed and why] - Diff or file list: [textarea: Paste the diff stat or changed paths] - Tests run: [textarea: Commands and results] - Risk areas: [textarea: Parts you are least sure about] - Reviewer: [dropdown: Teammate who knows the code, Teammate new to the code, Outside maintainer] - Review size: [dropdown: Quick skim, Careful read, Deep audit] Write the request in this order. One paragraph on the purpose and the user-visible effect. The scope: what is in this change and what is deliberately left for later. A reading order: the two or three files to open first and why, then the rest grouped by role, with generated or mechanical files marked skippable. How it was tested, with commands and what each showed, plus what was not tested. Known gaps, shortcuts and follow-ups, stated honestly. Specific questions where the reviewer's judgement is wanted, such as a naming or a trade-off. Pitch the amount of background to the chosen reviewer, and keep the whole request under one page.