Basic steps for the reviewer
This section describes the basic steps that a reviewer goes through from seeing that a review needs reviewing to up voting the review.
The following steps are based on the workflow described at the start of this chapter, see Workflow: a step-by-step walk-through.
- Log in to Swarm.
- To check if you have any reviews that need your attention, open your Dashboard by clicking the Swarm Home
icon on the left of the main toolbar.
- From your Dashboard, click on the review ID to open the review.
- View the changes in the review by clicking the Files tab on the Review page, see Files tab and File diff view.
- Make a comment to explain what the issue is and flag it as a Task, see Make a comment on a review.
- Repeat the step above for each of the issues you have with the review.
- Vote the review down by clicking on your Avatar on the review page and selecting Vote Down from the dropdown menu.
- Set the review state to Needs Revision from the Review State dropdown button, see Change the review state.
- When the author has addressed your comments, the review returns to your dashboard with a review state of Needs Review.
- From your Dashboard, click the review ID link and check that your comments have been addressed:
- If you are satisfied that a comment has been addressed correctly, click Verify Task.
- If you are not satisfied that a comment has been addressed correctly, click Reopen Task and click the Reply link below the comment to explain why you have reopened the task.
- If you need to discuss a comment, reply to the original comment by clicking on the Reply link below the comment.
- If more changes are required, set the review state to Needs Revision from the Review State dropdown button, see Change the review state.
- The review/revision cycle is repeated until you are satisfied the review and no further changes are required.
- When you are satisfied with the review, vote it up by clicking on your Avatar in the review and selecting Vote Up from the dropdown menu.
- When the Minimum up votes requirement is satisfied, all of the required reviewers have voted the review up, and there are no Down votes on the review, Swarm automatically sets the review state to Approved.
- Rejected: used when a review is completed but the changes are undesirable and should not be committed, see Change the review state.
- Archived: used when the review has been completed for now but it is not rejected, or approved. The review has been filed away in case it is needed in the future.
For more information about your dashboard, see Check for code reviews that you need to act on.
Since it is tied to the logged in user, the dashboard is only populated if you are logged in.
For details about the Review page, see Review page quick reference.
If changes are required:
This moves the review back into the author's dashboard to indicate that changes are required.
This moves the review back into the author's dashboard to indicate that changes are required.
If changes are not required:
Vote up the review by clicking on your Avatar in the review and selecting Vote Up from the dropdown menu.
The approved review moves back to the author's Dashboard and can be committed by the author.
More review states: