Skip to content

Automate code style reviews

Thiago Figueiró requested to merge code-review-code-style into master

What does this MR do?

Suggest that code style be enforced via automation instead of during code review comments.

The Development Department headcount growth makes it ever less likely that human reviewers will consistently enforce code style.

In line with our Transparency value of reproducibility, code style/formatting enforcement should be done automatically. Doing so will also avoid unnecessarily slowing-down the Merge Request review process and help achieve our Mean Time To Merge KPI.

Because it's not always possible to write automation to enforce, and especially improve, code style, the change merely suggests rather than mandate this approach.

Related issues

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.

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