Skip to content

Add requirements for Quality code review approval

Mark Lapierre requested to merge ml-quality-code-review-approval into master

What does this MR do?

Once in a while there is confusion about who should review Quality-related changes, and the extent of Quality maintainers' responsiblity.

This is intended to convey that:

  • An MR with Quality-related changes must be reviewed by an SET (Reviewer Roulette and the existing note in the doc about domain experts already conveys which SET should be chosen if the author is unsure).
  • An MR that only includes Quality-related changes must be reviewed by a Quality maintainer.

It should also convey that...

  • An MR that includes non-Quality-related changes should be merged by another maintainer

...but I'm not sure how to add that to the docs. And I've already added two points that possibly could be one?

Related issues

Author's checklist (required)

When applicable:

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