Changes between Version 10 and Version 11 of PeerReviewPlugin/Documentation

Jan 24, 2016, 11:29:01 AM (6 years ago)

Added instructions for performing a review taken from included with the plugin.


  • PeerReviewPlugin/Documentation

    v10 v11  
    9090As seen above, the results include information on the review ID, author name, current status, and review name.  For each review listed, links are given to jump directly to the view code review page for the review.  Alternately, the constraints can be increased or relaxed by choosing different values for the fields and searching again.
    9191=== Perform Code Review
     92This page allows commentary on code reviews, and viewing others' comments.  All users can see the comments posted on this page.
    93 To be written.
     94[[Image(performCodeReview_1.PNG, 50%)]]
     96The page shows the file that is being commented on, as well as the revision number and starting and ending lines. Initially, the page shows the section under review with three lines of code on either side of the section. To expand the number of buffer lines shown at the beginning and end of a section, edit:
     98[[Image(performCodeReview_2.PNG, 250px)]]
     100Note that the number of lines will never exceed the beginning or end of the document.  In the case that an invalid number of lines is provided, the page will restore the last valid value entered.
     102Comments can be associated with each line in the range of lines the author wants others to examine. If a line already has some comments, it is denoted with a 'pin' symbol. The line numbers are links that will open a comment editor:
     104[[Image(performCodeReview_4.PNG, 250px)]]
     106After the comments box is opened, the "Refresh" link updates the comments box to the most updated comments (which is automatically done whenever the box is initially loaded). Also, users can reply directly to previous posts by clicking the "Reply" link under the existing comment.
     108Alternately, users can add a new comment by clicking the "Add New Comment" button:
     110[[Image(performCodeReview_5.PNG, 250px)]]
     112This will open up a new comment box, as shown above, where comments can be inserted into the text box.  A code sample can be attached as well by clicking on the "Attach Code Sample" box.  Then, type the pathname to the desired file on your computer or click the "Browse..." button to pull up a file selection dialog which will fill in the filename.  Finally, click on the "Add Comment" button to add the comment so others can view it, or click on the 'X' in the upper-right hand corner to cancel at any time.
    95114=== View Code Review
    97 To be written.
    99 === Manager Options
    101116To be written.