Skip to content

docs: update template with guidance on QA issues

Ben Prescott_ requested to merge docs-bprescott-labels-20200604 into master

What does this MR do?

It revises the merge request template for documentation.

It adds guidance to help ensure folks' merge requests don't get into the automatic QA issues if that isn't required.

Remove the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be included when the automatic QA issue is created.

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