Skip to content

Reviewing

Comments and regions

Discuss a build with threaded comments and @mentions, and pin a comment to a region of a screenshot.

Every build has a discussion in the Comments tab beside the image. A comment can be general, or pinned to a rectangle on one screenshot. Anyone who can see the project can read and write comments.

CirCI
The Comments tab of build #79. A comment by Olivia Owner is pinned to region 1 of the dashboard/overview screenshot, with replies from Hannah Weber and Olivia Owner. Its chip reads 1 · dashboard/overview.
A comment pinned to region 1 of dashboard/overview, with two replies. The marker on the new image shows where.

Press c on the build page, or open the Comments tab and click the field. Type, then press the Comment button or CommandEnter. A comment is at most 5000 characters. The tab's badge counts the comments in the build.

  • Reply under a comment starts a reply. A reply can't have replies, so reply to the first comment of the thread.
  • Edit and Delete show under your own comments. An edited comment says "(edited)". Owners and admins of the workspace can delete anyone's comment, but only the author edits it.
  • Deleting asks first ("It can't be restored") and leaves "This comment was deleted." in the thread.

Type @ and pick a person from the list. A mention notifies that person in their Inbox, and by push notification when they have it on. See Inbox and reviews and Account settings.

A mention is matched to a project member by the part of their email before the @, or by their name written as one word (annlee, ann-lee, ann.lee, ann_lee), ignoring case. If a handle fits nobody, or fits two members, it mentions no one and nobody is notified. Pick from the list to be sure. When you edit a comment, only people you newly mention are notified.

  1. Open the screenshot. Any compare mode works.

  2. Drag a rectangle. Cover the part you mean, on the baseline or on the new screenshot.

  3. Write the comment. Use the box that opens. CommandEnter sends it, Cancel or Escape drops it.

The region appears as a numbered marker on the image. Each comment region has its own color, chosen by its number (the ninth starts the palette again, and the number tells the two apart): the box on the image, its pin and the comment's chip are the same color. The box is outlined so it stands out on any screenshot. The same number shows beside the thread in the Comments tab, in a chip with the screenshot's name ("1 · pricing"), and the screenshot's row in the list shows how many comments it has. Click a marker to jump to its thread, or the chip to jump to its screenshot. A region remembers which side it was drawn on, baseline or new.

Regions scale with the image, so they stay in place at any zoom. The smallest region is 1% of the screenshot in each direction.

To change a region, drag its corner handles or move it. Only the author does this, and a "Region saved" toast confirms it.

For keyboard users, the Mark a region with the keyboard button (the crosshair in the toolbar above the image) starts a region: the arrow keys move it, Shift + arrow keys resize it, Enter confirms, Escape cancels.

Owners and admins get a second choice in the View options menu (the ⋯ button above the image) under Dragging draws: Comments or Ignore regions. With Ignore regions, a drag adds an area to leave out of every future comparison of that screenshot. This is a different thing from a comment region: it changes how builds are judged, and it looks different. An ignore region is a hatched box in neutral ink with a numbered tag, with no color, so it can't be taken for a comment. See Baselines and ignore regions. Members only see the Comments behavior.

  • The Activity tab lists each comment ("commented on checkout/cart.png"); selecting it opens the thread.
  • A mention in the Inbox opens the build on the Comments tab, with the screenshot and thread selected.