A review mechanism is the channel through which new or changed code is presented for evaluation. It connects the author’s code, one or more reviewers, feedback, and a signoff condition within a broader code review workflow. section 2.2.1
Choose the mechanism that fits the team’s tools, communication patterns, and desired formality:
- Use a pull request (PR) to propose changes from one branch into a target branch, commonly through Git-based version control. section 2.2.1
- Use a merge request (MR) for the equivalent GitLab feature; the names differ, but both encapsulate the intent to make changes. section 2.2.1
- Use email patches, scheduled meetings, team messages, or an IDE display when the team’s review process calls for those channels. section 2.2.1 section 2.5
Define the mechanism in a team workflow
A team might start with new or changed code, request review by opening a PR, assign two or more reviewers, collect feedback as platform comments, require authors to address comments, and finish when the agreed signoff condition is met. Documenting these steps gives new and existing team members a shared reference. section 3.3.1
Figure 2.2 A high-level workflow of the typical, modern code review
Use the high-level workflow diagram to see how new or changed code, reviewers, the reviewing mechanism, and signoff fit together. section 2.2.1
