Version 95 (modified by 7 years ago) (diff) | ,
---|
Categories
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:
- CodeCommentsPlugin Comment on deliverables and link to tickets
- CodeReviewPlugin Code review of changesets
- CodeReviewerPlugin Lightweight code review of changesets
- ExoWebCodeReviewPlugin Apply code reviews to changesets
- PeerReviewPlugin Distributed Peer Review of Source Code
- PeerReviewPlugin/Documentation Distributed Peer Review - User Guide
Bugs/Feature Requests
Existing bugs and feature requests for PeerReviewPlugin are here.
If you have any issues, create a new ticket.
defect |
93 / 99 |
||
---|---|---|---|
enhancement |
13 / 28 |
||
task |
6 / 7 |
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
- 18288 by Cinc-th on 2021-05-12 06:30:30
-
PeerReviewPlugin: improvements to ticket creation:
- You may specify a list of review states for which the ticket creation section is shown.
- A ticket template may be provided as a wiki page
CodeReview/TicketTemplate
- Ticket creation section is foldable now
- Added documentation to plugin
- 18287 by Cinc-th on 2021-05-11 11:52:23
-
PeerReviewPlugin: improvements to changeset reviews:
- Allow to create another changeset review when old review was closed.
- Show pin icon in lines with comments
- Hide/show comments
Some minor improvements to presentation like titles for revision links.
Refs #14007
- 18286 by Cinc-th on 2021-05-10 10:49:44
-
PeerReviewPlugin: review creation for a changeset failed if the changeset contained any deleted files.
Refs #14007
(more)
Author/Contributors
Author: Team5
Maintainer: Cinc-th
Contributors: sontek, djeebus, proofek, blongden, bselby, Rys?, andersm, rjollos, yudivian
Attachments (2)
-
perform_code_review.jpg (211.8 KB) - added by 18 years ago.
Performing a code review
-
new_code_review.jpg (157.1 KB) - added by 18 years ago.
Creating a code review - selecting line numbers
Download all attachments as: .zip