How to make Pull Request easy to review

Make it easy to get to related task

• Start title with task id
  • Some task trackers can link such PRs to related ticket
  • It also helps to find PR by task id later
• Add a link to the task in description. So you can go to task in one click

Show and tell what's it about

• Include screenshots or video for UI changes (!). This one is huge, it makes review a lot easier. Moreover, these materials can be used for internal demo.
• Include text description

Highlight key parts

• Add comments in your PR to bring attention or share knowledge
  • Comment parts you I not sure about and want to discuss
  • Highlight solutions you want your colleagues to know about

What I've not used or used rarely (it may be good thing):

• Checklists – good for long-standing PR, to track progress; or for tracking "to do" plan after merge
• Tags – I know that some teams use tags for categorizing PR size or show readiness

Meta

Created: 2022-09-08 Created: 2024-05-11

References: