| 1 | TEAM5 |
|---|
| 2 | A Distributed Peer-Review Plug-in for TRAC Project Management System |
|---|
| 3 | README |
|---|
| 4 | |
|---|
| 5 | =================== |
|---|
| 6 | License Information |
|---|
| 7 | =================== |
|---|
| 8 | This software is licensed as described in the file COPYING.txt, which |
|---|
| 9 | you should have received as part of this distribution. |
|---|
| 10 | |
|---|
| 11 | ============ |
|---|
| 12 | Installation |
|---|
| 13 | ============ |
|---|
| 14 | Installation instructions for a Trac plugin can be located at |
|---|
| 15 | Edgewall Software <http://projects.edgewall.com/trac/wiki/TracPlugins>. |
|---|
| 16 | |
|---|
| 17 | ====================================== |
|---|
| 18 | Configuring Trac's main navigation bar |
|---|
| 19 | ====================================== |
|---|
| 20 | By default, the navigation button for the Peer Review button will appear |
|---|
| 21 | on the far right of the main navigation bar in Trac. It is only visible |
|---|
| 22 | when a valid user logs into the system. To change this option, locate |
|---|
| 23 | and modify the following line in the trac.ini file. It may be commented |
|---|
| 24 | out, so first uncomment the line. |
|---|
| 25 | |
|---|
| 26 | mainnav = wiki,timeline,roadmap,browser,peerReviewMain,tickets,newticket,search |
|---|
| 27 | |
|---|
| 28 | |
|---|
| 29 | The above example places the Peer Review button (called codereview) between |
|---|
| 30 | the browser and tickets buttons. You can rearrange these in any order for |
|---|
| 31 | your desired effect. |
|---|
| 32 | |
|---|
| 33 | ====================== |
|---|
| 34 | How to add user rights |
|---|
| 35 | ====================== |
|---|
| 36 | User priveledges can be set using Trac's built-in administrative program: |
|---|
| 37 | trac-admin. The possible user priveledges are as follows: |
|---|
| 38 | |
|---|
| 39 | CODE_REVIEW_DEV : Individuals with this access level will be able to view, |
|---|
| 40 | create, search, and perform code reviews. |
|---|
| 41 | |
|---|
| 42 | CODE_REVIEW_MGR : This access level allows users to modify the status of a |
|---|
| 43 | code review and change the plugin configuration options, along with all the |
|---|
| 44 | priveledges present in CODE_REVIEW_DEV. |
|---|
| 45 | |
|---|
| 46 | Please refer to trac-admin help utility for information on how to set |
|---|
| 47 | user priveledges. |
|---|
| 48 | |
|---|
| 49 | *Note: Granting the aforementioned priviledges to anonymous exclusively, without |
|---|
| 50 | specifying other specific users, will result in a situation where our plugin cannot correctly |
|---|
| 51 | identify users. This method of operation is not supported. |
|---|
| 52 | |
|---|
| 53 | ======= |
|---|
| 54 | Authors |
|---|
| 55 | ======= |
|---|
| 56 | The original purpose of the project was for a 2005-2006 senior project at |
|---|
| 57 | Rose-Hulman Institute of Technology. The project supervisor was Mark Ardis, and |
|---|
| 58 | the project client was William Nagel. The team members consisted of: |
|---|
| 59 | |
|---|
| 60 | Brandon Cannaday |
|---|
| 61 | Gabriel Golcher |
|---|
| 62 | Michael Kuehl |
|---|
| 63 | Anthony Panozzo |
|---|
| 64 | Adam Westhusing |
|---|
| 65 | |
|---|
| 66 | =================== |
|---|
| 67 | Contact information |
|---|
| 68 | =================== |
|---|
| 69 | Website - http://tracreview.sourceforge.net |
|---|
| 70 | Email - tracteam5@users.sourceforge.net |
|---|
