wiki:PeerReviewPlugin

Distributed Peer Review of Source Code

Description

This plugin integrates a distributed peer review system for software developers into Trac. The plugin eliminates the need for time consuming code review meetings by giving developers the ability to review code in a user-friendly web-based environment during their own time and in a distributed manner. The interface integrates seamlessly with your repository, thereby allowing users to browse it for reviewable files.

The purpose of this plugin is to review files from the repository and comment on them. Later on one may check the applied changes against the original file using a diff view. The plugin is not meant for reviewing change sets (#224).

Key features:

  • Support for multiple repositories (since [15598])
  • Diff view of changes in follow up reviews
  • Use wiki formatting in comments
  • Inline display of comments
  • Mark comments as read
  • Customizable review workflows
  • Custom reports
  • Export data in MS Word docx format

Further documentation:

The plugin uses code from TestManagerForTracPlugin for the workflow feature (see TestManagerForTracPluginWorkflow) and persistence of objects (see TestManagerForTracPluginGenericClass). Thanks to Roberto Longobardi for making it available under the permissive bsd-license.

See also:

Bugs/Feature Requests

Existing bugs and feature requests for PeerReviewPlugin are here.

If you have any issues, create a new ticket.

defect

91 / 96

enhancement

9 / 23

task

4 / 6

If you have any comments about the plugin or/and you would like to join the discussion, please see ticket #2850.

Download

Download the zipped source from here.

Multirepository support is available in trunk.

Source

Check out PeerReviewPlugin from here using Subversion, or browse the source with Trac.

Installation

Follow the standard Trac plugin installation instructions.

Enable the plugin in your trac.ini file:

[components]
codereview.* = enabled

Configuration

Permissions

The permissions CODE_REVIEW_DEV and CODE_REVIEW_MGR must be assigned as appropriate:

  • Only users with permission CODE_REVIEW_DEV may perform code reviews.
  • Permission CODE_REVIEW_MGR is for administration of code reviews.

Workflow operation for reviews

You can configure a custom workflow operation set_review_owner for reviews:

[peerreview-resource_workflow]
change_owner = * -> *
change_owner.name = Change Owner to
change_owner.operations = set_review_owner
change_owner.permissions = CODE_REVIEW_MGR

This operation allows you to change the owner of a review. Possible users are taken from the same list as the one used when creating a review. In the given example you need the permission CODE_REVIEW_MGR to perform the operation.

Project list

When creating a review you can specify an associated project. The projects are taken from the list created by SimpleMultiProjectPlugin. If you don't have this plugin installed or you want to create another list, you may do so using the following settings:

[peerreview]
projects = Project1, Project2, Project3

Recent Changes

16617 by rjollos on 2017-05-26 03:52:24
TracCodeReview 3.1: Replace deprecated add_javascript with add_script

Fixes #13193.

16616 by rjollos on 2017-05-25 20:57:01
TracCodeReview 3.1: Fix incorrect imports

Refs #13193.

16451 by rjollos on 2017-04-04 07:12:08
Fix indentation
(more)

Author/Contributors

Author: Team5
Maintainer: Cinc-th
Contributors: sontek, djeebus, proofek, blongden, bselby, Rys, andersm, rjollos, yudivian

Last modified 36 hours ago Last modified on May 28, 2017, 11:24:31 AM

Attachments (2)

Download all attachments as: .zip