Skip to content

Simplify commenting in merge requests

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

To make reviews a first class workflow we need to simplify the way users can leave in a merge requests. Currently we present the user with too much choice.

By making the proposed changes we aiming to increase the effectiveness of how feedback is provided in reviews.

Action 1: Use "Add to review" and "Comment" as button labels

  • Add to review adds a comment to a review
    • Comments of a review are unresolved threads by default.
    • If the user selects "Comment only" when submitting the review #474794, then the comments do not require to be resolved.
  • Comment adds comment immediately

This means we will replace the following:

  • "Start a review" with Add to review
    • "Start a review" is already unclear for some people (evidence). Removing it as an option then takes the state of the button from 2 to 1 with "Add to review". By moving the pending review from the footer to the top right of the page #474794, we are adopting a pattern that is similar to e-commerce where the action "Add to cart" adds to the cart or basket.
  • "Add comment now" with Comment

Action 2: Replies are not the time where the default action is to contribute to your own review

When replying to a comment, the primary action will be "Comment" and the secondary is "Add to review".

Reply Reply and new comment
image image
Current reply buttons image

This might appear like a wrong move because we are not being consistent with the placement of our buttons especially if we want to make reviews a first-class workflow. However we know that this interaction of making replies start a review instead of commenting is a pattern that causes issues for our users #387369 (closed) #388913 Here the context that the user is trying to reply should take precedence over the consistency of presenting the buttons in the same order.

Edited by 🤖 GitLab Bot 🤖