Changes between Version 13 and Version 14 of PeerReviewPlugin/Documentation
- Timestamp:
- Jan 30, 2016, 10:13:27 AM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
PeerReviewPlugin/Documentation
v13 v14 11 11 Distributed peer review facilitates code review without the need for all team members to meet together, saving time. In addition, changes proposed under a distributed system are easier to implement. Our project seeks to create a distributed peer review system by creating a plugin for Trac, which is a browser-based content management system that includes bug-tracking. The plugin integrates with Subversion, a popular open-source version control system. 12 12 13 Trac supports plugin development with Python on the backend, and [http://trac.edgewall.org/wiki/ClearSilver ClearSilver], a fast and powerful HTML template system, on the front-end. Javascript and AJAX were used to provide pages with dynamic features. An SQLite database is utilized to store all information about reviews and users.14 13 15 14 '''Note:''' Since version 2.1 this plugin uses the new template engine Genshi, and supports SQLite, PostgreSQL and MySQL as database backends. … … 23 22 The 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. 24 23 25 [[Image(mainPage_2.PNG, 400px)]]24 [[Image(mainPage_2.PNG, 500px)]] 26 25 27 26 The 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. 28 27 29 [[Image(mainPage_3.PNG, 400px)]]28 [[Image(mainPage_3.PNG, 500px)]] 30 29 31 30 Managers 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. 32 31 33 [[Image(mainPage_1.PNG, 400px)]]32 [[Image(mainPage_1.PNG, 500px)]] 34 33 35 34 Finally, 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. … … 54 53 Navigation 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"). 55 54 56 [[Image(newCodeReview_step2_1.PNG, 500px)]]55 [[Image(newCodeReview_step2_1.PNG, 700px)]] 57 56 58 57 Once a file has been opened, the repository browser will look similar to this: 59 58 60 [[Image(newCodeReview_step2_2.PNG, 500px)]] 61 62 In 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. 63 64 Once the correct lines of code have been selected, click "Add File" to add the code to the code review. The location will appear in the table below the repository browser, along with the line numbers and revision number. 59 [[Image(newCodeReview_step2_2.PNG, 700px)]] 60 61 There are two ways to select a file to be added into the peer review. 62 1. Select one or more files in the repository browser and click ''Add files''. This adds the complete files to a review. Note that the select boxes are not shown in the screenshots. 63 1. 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. 64 65 Once the correct lines of code have been selected, click ''Add File'' to add the code to the code review. The location will appear in the table below the repository browser, along with the line numbers and revision number. 66 65 67 66 68 ==== Add reviewers … … 82 84 This 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. 83 85 84 [[Image(peerReviewSearch_1.PNG, 500px)]]86 [[Image(peerReviewSearch_1.PNG, 700px)]] 85 87 86 88 To 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. 87 89 88 [[Image(peerReviewSearch_2.PNG, 500px)]]90 [[Image(peerReviewSearch_2.PNG, 700px)]] 89 91 90 92 As 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. … … 92 94 This page allows commentary on code reviews, and viewing others' comments. All users can see the comments posted on this page. 93 95 94 [[Image(performCodeReview_1.PNG, 500px)]]96 [[Image(performCodeReview_1.PNG, 700px)]] 95 97 96 98 The 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: 97 99 98 [[Image(performCodeReview_2.PNG, 250px)]]100 [[Image(performCodeReview_2.PNG, 300px)]] 99 101 100 102 Note 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. … … 102 104 Comments 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: 103 105 104 [[Image(performCodeReview_4.PNG, 250px)]]106 [[Image(performCodeReview_4.PNG, 400px)]] 105 107 106 108 After 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. … … 108 110 Alternately, users can add a new comment by clicking the "Add New Comment" button: 109 111 110 [[Image(performCodeReview_5.PNG, 250px)]]112 [[Image(performCodeReview_5.PNG, 300px)]] 111 113 112 114 This 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. … … 118 120 At the top of the page the name, status, author, and creation date of the code review are listed: 119 121 120 [[Image(viewCodeReview_1.PNG, 300px)]]122 [[Image(viewCodeReview_1.PNG, 500px)]] 121 123 122 124 Next, the files that this code review encompasses are listed: 123 125 124 [[Image(viewCodeReview_2.PNG, 500px)]]126 [[Image(viewCodeReview_2.PNG, 700px)]] 125 127 126 128 The 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. … … 130 132 Managers can see whether each user has voted, and what their vote was if they have voted: 131 133 132 [[Image(viewCodeReview_4.PNG, 500px)]]134 [[Image(viewCodeReview_4.PNG, 700px)]] 133 135 134 136 The author of the review can only see whether each user has voted or not: 135 137 136 [[Image(viewCodeReview_9.PNG, 500px)]]138 [[Image(viewCodeReview_9.PNG, 700px)]] 137 139 138 140 Users that are neither author nor manager of the review can only see the users that are assigned to the code review: 139 141 140 [[Image(viewCodeReview_3.PNG, 500px)]]142 [[Image(viewCodeReview_3.PNG, 700px)]] 141 143 142 144 Next, the author's notes and instructions are visible, which are general comments that the author has about the code review: … … 171 173 This page allows a manager to set manager options. 172 174 173 [[Image(options_1.PNG, 500px)]]175 [[Image(options_1.PNG, 700px)]] 174 176 175 177 The voting threshold is currently the only manager option that can be set. The voting threshold can be changed by altering the value in the field to an integer value between 0 and 100 and clicking on the "Set Threshold" button.
