wiki:PeerReviewPlugin/Documentation

Version 6 (modified by eric, 6 years ago) (diff)

--

Distributed Peer Review - User Guide

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.

My code reviews list

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.

Assigned code reviews

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.

Code reviews awaiting approval

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 (3)

Download all attachments as: .zip