Changes between Version 11 and Version 12 of PeerReviewPlugin/Documentation


Ignore:
Timestamp:
Jan 24, 2016, 12:01:43 PM (6 years ago)
Author:
Cinc-th
Comment:

Added description of view review screen taken from UserGuide.zip included with the plugin.

Legend:

Unmodified
Added
Removed
Modified
  • PeerReviewPlugin/Documentation

    v11 v12  
    2323The first table is the list of code reviews where you are the author. Clicking on any element in a particular row will take you to the View Code Review page for that row. Also, this table displays the code review ID, code review name, current status of the review, and the date that the review was opened.
    2424
    25 [[Image(mainPage_2.PNG, 50%)]]
     25[[Image(mainPage_2.PNG, 400px)]]
    2626
    2727The second table is the list of code reviews where you are the reviewer. Clicking on any element in a particular row will redirect to the View Code Review page for that row. Also, this table displays the code review ID, code review author, review name, your voting status for the review, and the date that the review was opened.
    2828
    29 [[Image(mainPage_3.PNG, 50%)]]
     29[[Image(mainPage_3.PNG, 400px)]]
    3030
    3131Managers will see an additional table at the top of the page above the two tables that are typically there for a developer. These are the code reviews that need to be reviewed by a manager. After approval by a manager, the manager should add the changes in the code review to the development trunk.
    3232
    33 [[Image(mainPage_1.PNG, 50%)]]
     33[[Image(mainPage_1.PNG, 400px)]]
    3434
    3535Finally, just below the navigation bar in the upper right corner are some navigation links for moving through the plugin. The links will take you to the Main Page, New Code Review Page, and Search Code Review Page, respectively.
     
    4747This will be the name that will appear on the main page after the code review is created. A name cannot be longer than fifty characters in length.
    4848
    49 [[Image(newCodeReview_step1.PNG)]]
     49[[Image(newCodeReview_step1.PNG, 300px)]]
    5050
    5151==== Add files
     
    5454Navigation through this repository is identical to navigation through the TRAC repository.  Clicking on folders navigates through the folder.  Clicking on files will open that file if an HTML preview is available.  To navigate back up, click on the corresponding folder above the repository (for example, where it says "root").
    5555
    56 [[Image(newCodeReview_step2_1.PNG, 50%)]]
     56[[Image(newCodeReview_step2_1.PNG, 500px)]]
    5757
    5858Once a file has been opened, the repository browser will look similar to this:
    5959
    60 [[Image(newCodeReview_step2_2.PNG, 50%)]]
     60[[Image(newCodeReview_step2_2.PNG, 500px)]]
    6161
    6262In order to select a file to be added into the peer review, click the corresponding lines of code on the left that you would like to add.  For example, here the user clicked on 82 and clicked on 87 to select lines 82-87. Alternately, the user could type those numbers into the corresponding text boxes below the repository browser.
     
    6969Only users with permission ''CODE_REVIEW_DEV'' will be shown in the dropdown list.
    7070
    71 [[Image(newCodeReview_step3.PNG, 25%)]]
     71[[Image(newCodeReview_step3.PNG, 250px)]]
    7272
    7373==== Provide notes and instructions
     
    7575General comments can be added to the code review. These comments can be seen by anyone viewing the code review.
    7676
    77 [[Image(newCodeReview_step4.PNG, 50%)]]
     77[[Image(newCodeReview_step4.PNG, 400px)]]
    7878
    7979After adding general comments, the user is ready to add the code review. Click "Add Code Review" at the bottom of the page to do this.  The user will be taken to the View Code Review page for this code review.
     
    8282This page helps search for code reviews, given relevant information to find the correct code reviews.  First, search constraints are selected, and then a search is performed by clicking on the search button.  When search constraints are selected and a search is performed, code reviews that still satisfy the constraints are listed.  If no constraints are given, all reviews, both active and inactive (closed), are listed.  Combinations of fields narrow the search results.  For example, searching for reviews after one month ago and by a certain author will likely return less results than searching by one of the constraints alone.  It is possible to constrain the search such that no results are returned.  Such a condition is indicated after searching.
    8383
    84 [[Image(peerReviewSearch_1.PNG, 50%)]]
     84[[Image(peerReviewSearch_1.PNG, 500px)]]
    8585
    8686To find a particular code review name or code review names that contain certain characters, enter it in the "Code Review Name" field.  Further, to find reviews after a certain date, enter the date in the second set of input boxes.  Likewise, to constrain the returned results of the search to a certain status, change the "Status" field.  Finally, to find all code reviews matching a certain author, fill in the final field.  After specifying the constraints for the search, click on the "Search" button.
    8787
    88 [[Image(peerReviewSearch_2.PNG, 50%)]]
     88[[Image(peerReviewSearch_2.PNG, 500px)]]
    8989
    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.
     
    9292This page allows commentary on code reviews, and viewing others' comments.  All users can see the comments posted on this page.
    9393
    94 [[Image(performCodeReview_1.PNG, 50%)]]
     94[[Image(performCodeReview_1.PNG, 500px)]]
    9595
    9696The 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:
     
    114114=== View Code Review
    115115
    116 To be written.
     116This page allows users to view the details of a given code review.
     117
     118At the top of the page the name, status, author, and creation date of the code review are listed:
     119
     120[[Image(viewCodeReview_1.PNG, 300px)]]
     121
     122Next, the files that this code review encompasses are listed:
     123
     124[[Image(viewCodeReview_2.PNG, 500px)]]
     125
     126The file ID, filename, revision number, and line numbers of the files are prominently displayed in this table. Upon clicking on any of the links given in the table, the user will be taken to the perform code review page for the file in question. Note that this file is unique for each code review, regardless of duplication across separate code reviews. Also, the filename can be identical, with different line numbers.  This is so that two very different portions of the file that the author modified can be shown without all of the lines in between. In the example above, about 140 lines would have needed to be shown if only one file was used.
     127
     128Next, the users assigned to this code review and their vote status are visible.
     129
     130Managers can see whether each user has voted, and what their vote was if they have voted:
     131
     132[[Image(viewCodeReview_4.PNG, 500px)]]
     133
     134The author of the review can only see whether each user has voted or not:
     135
     136[[Image(viewCodeReview_9.PNG, 500px)]]
     137
     138Users that are neither author nor manager of the review can only see the users that are assigned to the code review:
     139
     140[[Image(viewCodeReview_3.PNG, 500px)]]
     141
     142Next, the author's notes and instructions are visible, which are general comments that the author has about the code review:
     143
     144[[Image(viewCodeReview_5.PNG, 350px)]]
     145
     146Below this is the vote summary, which summarizes the votes for insertion into the main trunk of the project, votes against insertion into the main trunk of the project, and votes that have not been cast:
     147
     148[[Image(viewCodeReview_6.PNG, 350px)]]
     149
     150This summary is only visible if the user is a manager or author or is a reviewer that has voted.
     151
     152Voting members for the code review can vote if they have not voted, or view their votes and modify them if they have voted:
     153
     154[[Image(viewCodeReview_7.PNG, 300px)]]
     155
     156The author of the review can submit the code review for inclusion, resubmit for review, or close the code review:
     157
     158[[Image(viewCodeReview_10.PNG, 350px)]]
     159
     160Submitting the review for inclusion can only be performed when the percentage of the reviewers that have voted 'Yes' exceeds the threshold set by the manager.
     161
     162There is no way to change a code review once it has been created.  However, resubmitting for review closes a code review and creates a new code review with the same parameters.  A developer might want to resubmit for review if changes were proposed and the changes have been implemented.  In this case, there is a different set of code for reviewers to look at, so a new review should be created to reflect this.  However, creating another review with the same parameters would normally be painstaking.
     163
     164Authors can also close their code reviews, removing it from reviewers' main pages.  It can still be viewed when searching.
     165
     166Finally, if you are the manager of a code review, you can change the status or resubmit for review at any time:
     167
     168[[Image(viewCodeReview_8.PNG, 350px)]]
     169
     170
    117171
    118172=== Manager Options