Add a section of examples to code review docs
What does this MR do?
We have a fairly good guide to Code Reviews, but can be improved by adding a few examples of what a good code review looks like at GitLab, specifically ones where there is a bit of back and forth, "nit-picking," etc. This would:
-
help set expectations of newly hired engineers around what our process looks like when it is functioning what level of scrutiny their code will be under
-
how we have technical conversations
-
show by example how after you're done crafting a solution, there can still be extra work done either tidying up code and/or managing the communication and conversations about your proposed MR
Related issues
Closes #64194 (closed)
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. - [-] Link docs to and from the higher-level index page, plus other related docs where helpful.
-
Apply the ~Documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.