Skip to content

Update merge request reviewer prep guidelines

Doug Stull requested to merge doc-update-mr-review-workflow into master

What does this MR do?

Documents that the MR author should wait for a passing pipeline before assigning to be reviewed.

At times I find myself in this cycle:

  1. MR author asks me for a review.
  2. I happen to respond to that request and check before the pipeline has finished.
    • perhaps it fails, this causes even more cycles.
  3. I then go away from the request and revisit either later in the day or next day.

This causes me to get into multiple async sessions on the MR and perhaps even delays my review of the MR longer than it would usually be due to a FIFO cycle I may follow.

It would likely be more efficient(not always true as this is more of a grey area):

  1. MR author waits for pipeline to be successful.
  2. MR author asks me for a review.
  3. I review in one async cycle.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

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

  • 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.
    • Ensure docs metadata are present and up-to-date.
    • Ensure Technical Writing and documentation are added.
    • Add the corresponding docs:: scoped label.
    • Add twdoing when starting work on the MR.
    • Add twfinished if Technical Writing team work on the MR is complete but it remains open.

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 Alper Akgun

Merge request reports