ViewArticle

[Collapse]Collaborator 10
 [Expand]General Information/viewarticle/80040/
 [Collapse]Getting Started/viewarticle/80359/
   Getting Started For System Administrators/viewarticle/80348/
  [Collapse]Getting Started For Developers/viewarticle/80397/
    Creating Reviews/viewarticle/80394/
    Participating in Reviews/viewarticle/80395/
    Reworking Defects/viewarticle/80396/
 [Expand]Collaborator Server/viewarticle/80060/
 [Expand]Web Client/viewarticle/80107/
 [Expand]Desktop Clients/viewarticle/80151/
 [Expand]Version Control Integration/viewarticle/80048/
 [Expand]External Integrations/viewarticle/80340/
 [Expand]Techniques & Best Practices/viewarticle/80403/
 [Expand]Appendices/viewarticle/80117/
Updated: 12/23/2016 Applies To: Collaborator 10 Rating: No votes Click to rate: PoorNot badAverageGoodExcellent

Getting Started > Getting Started For Developers

Top |Previous |Next

Participating in Reviews

When someone invites you to a review, you receive an email notification. To take part in this review you need to open Collaborator Web Client.

1. Log Into the Web User Interface

Start your favorite web browser and navigate to Collaborator Web Client URL. If asked, enter your user name and password in the login screen.

In the Action items list on the Home screen, you will see a new incoming review.

gs-dev-actionitems

2. Open Review Summary Screen

Click the review in the Action items list to open it in the Review Summary screen where you can see the details about this review.

gs-dev-review-summary

Notice that you are the active participant of this review and the review is in the Inspection phase.

3. Inspect Review Materials

Scroll to the Review Materials section and click the uploaded file (or the first of several uploaded files). The Diff Viewer will open.

Diff Viewer displays the contents of the chosen file and allows to add your comments and defects on this file. The Viewer appearance changes a little depending on a type of the current file.

If a version history is available for the file (for example, when it was added from a source control system or when it was reworked by the author), the Viewer shows the current and previous versions of the file and highlights the differences between them.

gs-dev-diff-viewer1

4. Add Your Comments, Look for and Verify Defects

While reviewing, you most likely find some issues with the materials or would like to ask or tell something to the author. For this purpose you can add comments and defects.

If you are reviewing a file that has already been reworked, then you will need to verify whether the defects have been fixed.

To add a comment, click on the line (in text files) or area (in supporting docs) you want to comment on, type your comment and click Add. Comments are threaded into a conversation that stays tied to a specific line or area.

gs-dev-review-comment

To add a defect, click on the line (in text files) or area (in supporting docs) to which you want to attribute the defect, enter issue description and click Add as Defect. In the ensuing pane specify defect severity level and type and click Add Defect.

gs-dev-review-defect

To mark a previously found defect as fixed, scroll to the line (in text files) or area (in supporting docs) where the defect was found, and press Mark Fixed.

Besides creating comments and defects that relate to a specific line or area you can also create comments and defects that relate to entire files (in the Overall section of Diff Viewer) as well as comments and defects that relate to the whole review (in the Chat section of the Review Summary screen). See Review Chats for more information on making conversation during reviews.

When you have examined the current file, you can proceed to another file that was uploaded to the review (if any). To view the next or previous files, you may use the File navigation buttons on the Diff Viewer toolbar:

dv_toolbar

To return back to Review Summary screen, click Back button on the Diff Viewer toolbar.

5. Finish Inspection

Having inspected all the files that were uploaded to the review, scroll to the Next Steps section of the Review Summary screen.

In this section you need to indicate whether you are finished with the inspection or waiting on further actions from other participants.

gs-dev-next-steps1

To signal other participants that you have temporarily stepped out from the review but plan to return, press Wait.

In the ensuing list select when Collaborator should re-invite you to the review.

Wait Options

Wait Options

To signal other participants that you have inspected the uploaded files, press green button. The exact caption of the button varies depending on the phase the review will move to.

If you have created any defects, then the button caption will be "Send to Rework" and pressing it will return the review back to author to fix the found defects. Otherwise, the caption will be "Send to Completed" and pressing it will indicate that you approve the changes in the uploaded materials. A review cannot be completed until all defects are resolved: either marked as fixed, deleted, or tracked externally.

Where to Go Next

To learn how about correcting the found defects as an author, see Reworking Defects.




© 2017 SmartBear Software. All rights reserved.
Email Send feedback on this document