Skip to content

Add a new section on iteration to Code Review docs

Robert May requested to merge suggestion-for-code-review-docs into master

What does this MR do?

I'd like to suggest this change to the Code Review docs under "The right balance". At the moment I'm finding a lot of my MRs are spending a lot of time being passed back-and-forth (mostly due to time-zone differences between myself and the reviewer) over predominantly style choices.

Opinions welcome 😄

Author's checklist

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

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports