Changes between Version 99 and Version 100 of PeerReviewPlugin


Ignore:
Timestamp:
Apr 24, 2021, 9:46:44 AM (3 years ago)
Author:
Cinc-th
Comment:

Added information to description section

Legend:

Unmodified
Added
Removed
Modified

  • PeerReviewPlugin

    v99 v100  
    55== Description
    66
    7 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.
     7This plugin integrates a code review system for software developers into Trac.  The interface integrates seamlessly with your repositories and Tracs source browser, thereby allowing users to work in their known environment.
    88
    9 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).
     9The plugin can be used when developing software for regulated environments like [wikipedia:IEC_61508 IEC 61508] by
     10* enforcing proper processes using [wiki:PeerReviewPlugin/Workflows review workflows] and assigned reviewers,
     11* tracking the review status for every single source file of your software,
     12* maintaining a [https://en.wiktionary.org/wiki/paper_trail paper trail] for your review activities,
     13* documenting your reviews by exporting them into MS Word ''docx'' files.
    1014
    11 Trac 0.12 is supported up to V3.1, see [browser:/peerreviewplugin/tags/0.12/3.1].
     15You may chose files from the repository and comment on them. Later on one may check the applied changes against the original file during a follow-up review using a diff view. File changes may be {{{approved}}} or {{{disapproved}}} depending on the outcome of the review.
     16
     17The plugin is also suitable for reviewing changesets by integrating with the changeset page of Trac. 
     18
    1219
    1320Key features:
    14  * Support for multiple repositories (since [15598])
    15  * Diff view of changes in follow up reviews
     21 * Support for multiple repositories
     22 * Diff view of changes in follow up reviews similar to Tracs source browser
    1623 * Use wiki formatting in comments
    1724 * Inline display of comments
    … …  
    2229 * Export data in MS Word docx format
    2330
    24 This is the main page with code reviews that are to be performed by you as well as code reviews that you have requested to be performed by others:
     31**Note:** Trac 0.12 is supported up to V3.1, see [browser:/peerreviewplugin/tags/0.12/3.1].
    2532
    26 [[Image(PeerReviewPlugin/Documentation:my_code_reviews.png, 800px, border=2)]]
     33This is the main page with code reviews assigned to you and code reviews that you have created to be performed by others:
     34
     35{{{#!box width=500
     36==== Main page with review overview
     37[[Image(PeerReviewPlugin/Documentation:my_code_reviews.png, 480px, border=2)]]
     38}}}
    2739
    2840Further documentation:
    … …  
    6173
    6274== Installation
     75
     76**Note:** Trac 0.12 is supported up to V3.1, see [browser:/peerreviewplugin/tags/0.12/3.1].
    6377
    6478General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.