As someone who requests code review from your teammates, you typically perform the following sequence of tasks:
Commit changes to your VCS repository.
Create a code review.
Invite participants (reviewers and optionally watchers).
Discuss issues, if any, by way of exchanging comments with the reviewer(s).
Work on resolving the issues, commit the fixes, and add the new revision(s) to the existing review.
As soon as reviewers approve your changes, you close the review.
While committing changes is self-explanatory, we’ll describe the other steps below.
- Log into Upsource and locate your project in the list:
- Click on the project name to open it. The project home view displays the revisions listed in chronological order:
Scroll down the list or use the Search field to find the revision you’re interested in, then click on its title to open it.
Click Create Review in the upper right corner:
A new review is created and its ID is displayed at the top left (JD-CR-2 in our case):
The default review title is the same as your revision which becomes a part of this review. To change the review title, click the Edit icon next to it.
Add participants to the reviewers or watchers list depending on the action you want them to take.
To add a reviewer or a watcher:
Open the review and under the Overview tab click the plus sign below the corresponding heading.
Select the name from the pop-up list:
You can also add watchers while posting a comment: just type @ in the text field and the same list will appear.
You can add as many participants as you wish and whenever you wish: when starting a review, or at any time after that. The people you add are notified via e-mail and Upsource news feed.
To remove a participant, click its user pic Reviewers area and confirm the deletion:
You can post comments, addressing them to other participants, and reply to the comments left by reviewers. There are three types of comments:
Review comment is not tied up to any particular file or part of code - its subject matter may be anything within the scope of the review.
Code selection comment is intended to pinpoint a particular code fragment in one of the files being reviewed.
Line comment is associated with a specific line of code.
Posted code selection comments and line comments are embedded in code and highlighted with yellow.
To post a review comment, type your message in the text field at the bottom and click Add Comment:
To post a code selection comment:
Open the file and go Side-by-side diff or View file.
Select the lines you want to discuss and choose Comment on selection from the pop-up menu.
Type in your message and click Add Comment:
To post a line comment:
In the review home page, expand the file and select the line you want to comment on by clicking the edit icon to the left:
Enter your message in the text box and click Add comment:
When a discussion thread comes to a logical end, either you or the reviewer can mark it as resolved.
If the revision you had originally submitted for review was not approved by the reviewers, you can work on the issues, commit fixes, and attach one or several new revisions to the original review for approval.
This way the whole discussion and revision history is contained within one review, and as long as the review is open it will always be visible throughout the different revisions.
You can attach a new revision to an existing review either from that revision:
or from the review:
To detach a revision from a review, in the review home view, click the Remove icon next to the revision name:
As soon as all reviewers have approved your changes, and you expect no further input, you can close the review by clicking a corresponding button in the right pane: