Skip to content

Guidance on how to have a single comment mention per review request

Michael Le requested to merge mle-tagging-tw-on-designs into main

Why is this change being made?

In a discussion between technical writers and UX designers on 2024-02-08, it was suggested that rather than 10 @ mentions on individual UI text review request point that it would better to tag all of the review points but only mention the technical writer once.

This will help with the volume of notifications they get in their todos and allows for better context switching so that they know that they would need to look at a specific design rather than guessing if they need to address multiple different points when looking at the todos.

CHANGEME - Guidance on how to notify a review without overloading technical writer with notifications

  • Update file workflow.md

Author and Reviewer Checklist

Please verify the check list and ensure to tick them off before the MR is merged.

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
    • The when to get approval handbook section explains the workflow in more detail
  • For transparency, share this MR with the audience that will be impacted.
    • Team: For changes that affect your direct team, share in your group Slack channel
    • Department: If the update affects your department, share the MR in your department Slack channel
    • Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR

Merge request reports