51 | | The user is presented with the Subversion repository tied to TRAC. |
52 | | |
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"). |
54 | | |
55 | | [[Image(newCodeReview_step2_1.PNG, 700px)]] |
| 51 | |
| 52 | The user is presented with the Subversion repository tied to Trac. |
| 53 | |
| 54 | 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 | |
| 56 | [[Image(newCodeReview_step2_1.PNG, 700px, border=2)]] |
69 | | Select reviewers from the dropdown list and click "Add user" to add them to the table of reviewers. This is the list of people that will vote on whether or not the code for the current code review is acceptable. Reviewers may be removed by clicking their names in the reviewers table. |
70 | | |
71 | | Only users with permission ''CODE_REVIEW_DEV'' will be shown in the dropdown list. |
72 | | |
73 | | [[Image(newCodeReview_step3.PNG, 250px)]] |
| 69 | |
| 70 | Select reviewers from the dropdown list and click "Add user" to add them to the table of reviewers. This is the list of people that will vote on whether or not the code for the current code review is acceptable. Reviewers may be removed by clicking their names in the reviewers table. |
| 71 | |
| 72 | Only users with permission `CODE_REVIEW_DEV` will be shown in the dropdown list. |
| 73 | |
| 74 | [[Image(newCodeReview_step3.PNG, 250px, border=2)]] |
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. |
85 | | |
86 | | [[Image(peerReviewSearch_1.PNG, 700px)]] |
87 | | |
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. |
89 | | |
90 | | [[Image(peerReviewSearch_2.PNG, 700px)]] |
91 | | |
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. |
| 85 | |
| 86 | 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. |
| 87 | |
| 88 | 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. |
| 89 | |
| 90 | [[Image(peerReviewSearch_1.PNG, 700px, border=2)]] |
| 91 | |
| 92 | 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. |
| 93 | |
| 94 | [[Image(peerReviewSearch_2.PNG, 700px, border=2)]] |
| 95 | |
| 96 | 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. |
| 97 | |
112 | | [[Image(performCodeReview_5.PNG, 300px)]] |
113 | | |
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 | [[Image(performCodeReview_5.PNG, 300px, border=2)]] |
| 119 | |
| 120 | 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 populate 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. |
126 | | [[Image(viewCodeReview_2.PNG, 700px)]] |
127 | | |
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. |
| 132 | [[Image(viewCodeReview_2.PNG, 700px, border=2)]] |
| 133 | |
| 134 | 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 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 been needed to be shown if only one file was used. |
142 | | [[Image(viewCodeReview_3.PNG, 700px)]] |
143 | | |
144 | | Next, the author's notes and instructions are visible, which are general comments that the author has about the code review: |
145 | | |
146 | | [[Image(viewCodeReview_5.PNG, 350px)]] |
| 148 | [[Image(viewCodeReview_3.PNG, 700px, border=2)]] |
| 149 | |
| 150 | Next, the author's notes and instructions are visible, which are general comments that the author added about the code review: |
| 151 | |
| 152 | [[Image(viewCodeReview_5.PNG, 350px, border=2)]] |
164 | | There 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. |
165 | | |
166 | | Authors can also close their code reviews, removing it from reviewers' main pages. It can still be viewed when searching. |
| 170 | There 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. |
| 171 | |
| 172 | Authors can also close their code reviews, removing it from reviewers' main pages. It can still be viewed when searching. |
187 | | Developer:: A normal user. Can create code reviews and be assigned as a reviewer to them. Can search for code reviews, see reviews they created, and see reviews they are assigned to. |
188 | | |
189 | | Manager:: User with highest privileges. Can do everything that a developer can do. Can also change the status of a review at any time. When reviews have "Ready for inclusion" status, these appear on the manager's main page in a table. Can also view the Manager Options page. |
190 | | |
191 | | Resubmit:: Resubmitting for review takes an existing code review and creates a new code review based on it. The fields of the new review are filled in as they were when the original code review was created, and then the author can edit the review details. After creating this new review, the old one is closed. |
| 194 | Developer:: A normal user. Can create code reviews and be assigned as a reviewer to them. Can search for code reviews, see reviews they created, and see reviews they are assigned to. |
| 195 | |
| 196 | Manager:: User with highest privileges. Can do everything that a developer can do. Can also change the status of a review at any time. When reviews have "Ready for inclusion" status, these appear on the manager's main page in a table. Can also view the Manager Options page. |
| 197 | |
| 198 | Resubmit:: Resubmitting for review takes an existing code review and creates a new code review based on it. The fields of the new review are filled in as they were when the original code review was created, and then the author can edit the review details. After creating this new review, the old one is closed. |
195 | | Status:: The current state of the code review. The status dictates whether or not certain actions are possible. A manager can change the state at any time, and the author can close the review when it is open or reviewed. States include: |
196 | | |
197 | | * ''Open for review'' - Initial state of the review, where reviewers can vote on the review and add comments. |
198 | | * ''Reviewed'' - Enough people have voted yes to push the review over the threshold limit. At this point the review can be submitted for inclusion by the author. |
199 | | * ''Ready for inclusion'' - The author feels, and his/her reviewers agree, that the review is ready for inclusion into the main trunk. At this point it is the manager's responsibility to verify the review, merge the changes with the main trunk, and close the review when finished. No voting is possible during this stage. |
200 | | * ''Closed'' - The review can be viewed, but no more voting is possible. The review is not visible from anyone's main page, but can be accessed by directly typing the review id into the URL of the peerReviewView page or successfully searching for the file. |
| 202 | Status:: The current state of the code review. The status dictates whether or not certain actions are possible. A manager can change the state at any time, and the author can close the review when it is open or reviewed. States include: |
| 203 | |
| 204 | * ''Open for review'' - Initial state of the review, where reviewers can vote on the review and add comments. |
| 205 | * ''Reviewed'' - Enough people have voted yes to push the review over the threshold limit. At this point the review can be submitted for inclusion by the author. |
| 206 | * ''Ready for inclusion'' - The author feels, and his/her reviewers agree, that the review is ready for inclusion into the main trunk. At this point it is the manager's responsibility to verify the review, merge the changes with the main trunk, and close the review when finished. No voting is possible during this stage. |
| 207 | * ''Closed'' - The review can be viewed, but no more voting is possible. The review is not visible from anyone's main page, but can be accessed by directly typing the review id into the URL of the !PeerReviewView page or successfully searching for the file. |