Version 6 (modified by 15 years ago) (diff) | ,
---|
Distributed Peer Review - User Guide
Categories
Overview
Distributed Peer Review system is a plug-in for TRAC that facilitates distributed peer review of code. Normally peer review happens in a central location with paper copies of code, or works in an unorganized fashion involving email or other electronic means to communicate. However, these systems are inefficient for multiple code reviews, and can become unmanageable very quickly. Hence, this system assists developers in managing and performing code reviews in a distributed way.
Description
Distributed peer review facilitates code review without the need for all team members to meet together, saving valuable 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 plug-in for TRAC, which is a browser-based content management system that includes bug-tracking. The plug-in integrates with Subversion, a popular open-source version control system. TRAC supports plug-in development with Python on the backend, and 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.
Notes: Since version 2.1 plugin is going to use new template engine - Genshi, and support SQLite, PostgreSQL and MySQL database backends.
Manual
Main Page
The main page is displayed when the Peer Review button on the navigation bar is clicked.
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.
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.
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.
Finally, just below the navigation bar in the upper right corner are some navigation links for moving through the plug-in. The links will take you to the Main Page, New Code Review Page, and Search Code Review Page, respectively.
New Code Review
To be written.
Peer Review Search
To be written.
Perform Code Review
To be written.
View Code Review
To be written.
Manager Options
To be written.
Manager Options
To be written.
Glossary
To be written.
License/Disclaimer
To be written.
Attachments (27)
-
mainPage_2.PNG (9.9 KB) - added by 16 years ago.
My code reviews list
-
mainPage_3.PNG (17.0 KB) - added by 16 years ago.
Assigned code reviews
-
mainPage_1.PNG (8.5 KB) - added by 16 years ago.
Code reviews awaiting approval
-
peerReviewSearch_1.PNG (24.0 KB) - added by 8 years ago.
Specify search criteria
-
peerReviewSearch_2.PNG (32.2 KB) - added by 8 years ago.
Search results
-
performCodeReview_1.PNG (41.1 KB) - added by 8 years ago.
Code review screen
-
performCodeReview_2.PNG (1.2 KB) - added by 8 years ago.
Line selection
-
performCodeReview_4.PNG (20.8 KB) - added by 8 years ago.
Comment dialog
-
performCodeReview_5.PNG (5.7 KB) - added by 8 years ago.
Add new comment
-
viewCodeReview_1.PNG (5.4 KB) - added by 8 years ago.
Code review details
-
viewCodeReview_2.PNG (7.6 KB) - added by 8 years ago.
Code review files
-
viewCodeReview_3.PNG (5.5 KB) - added by 8 years ago.
Assigned users
-
viewCodeReview_4.PNG (6.6 KB) - added by 8 years ago.
Assigned users - authors view
-
viewCodeReview_5.PNG (4.2 KB) - added by 8 years ago.
Notes and instructions
-
viewCodeReview_6.PNG (2.4 KB) - added by 8 years ago.
Vote summary
-
viewCodeReview_7.PNG (3.0 KB) - added by 8 years ago.
Voting
-
viewCodeReview_8.PNG (4.0 KB) - added by 8 years ago.
Manager options
-
viewCodeReview_10.PNG (2.8 KB) - added by 8 years ago.
author options
-
viewCodeReview_9.PNG (10.8 KB) - added by 8 years ago.
User votes - author view
-
options_1.PNG (22.6 KB) - added by 8 years ago.
Manager options
-
newCodeReview_step1.PNG (15.8 KB) - added by 8 years ago.
New screenshot for review name
-
newCodeReview_step3.PNG (27.1 KB) - added by 8 years ago.
New screenshot for user selection
-
newCodeReview_step4.PNG (39.8 KB) - added by 8 years ago.
New screenshot for author notes
-
newCodeReview_step2_1.PNG (176.3 KB) - added by 8 years ago.
Screenshot update
-
newCodeReview_step2_2.PNG (152.8 KB) - added by 8 years ago.
Screenshot update for file preview in browser
-
assigned_reviews.png (117.6 KB) - added by 8 years ago.
List of assigned reviews
-
my_code_reviews.png (329.6 KB) - added by 8 years ago.
Main code review page: My Code Reviews
Download all attachments as: .zip