Skip to content

Rephrase DoD requirement on MR acceptance checklist

Paulina Sedlak-Jakubowska requested to merge psj-mr-checklist into master

What does this MR do?

During the last Code Review workshops we talked about the unchecked MR acceptance checklist. See the notes here (internal only). I raised that point since I want to propose a change to the checklist and seeing it unticked on so many MRs made me wonder if that change would even be noticed.

It often happens that the checklist is not ticked in the MR. It is also quite true that while we use the acceptance checklist heavily at the beginning of contributing to GitLab, we don't use it that often later on.

So after our discussion during the workshops, I'd want to propose two improvements:

  • Rephrase DoD requirement on MR acceptance checklist
    • Ticking the checklist does not necessarily ensure that all the guidelines are followed. Rewording this point let us make sure the content of the checklist is more important that the formality of checking it.
  • Add the date of the last update of the MR acceptance checklist and reference it in the MR templates that include the checkbox
    • This will help anyone contributing realised that there have been new guidelines they need to follow.
    • Since this is an additional manual step, I left a comment above it with instructions to make it a bit easier.

Related issues

n/a

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Paulina Sedlak-Jakubowska

Merge request reports