## page was renamed from CodeReviewExtension
== CodeReview Extension ==

'''This extension is not distributed with Mercurial'''

''Author: Roman Zeyde, Boris Glimcher''

 . Repository: http://bitbucket.org/romanz/hgcr/
 . Download: http://bitbucket.org/romanz/hgcr/src/tip/filereview.py
 . Bug reports: http://bitbucket.org/romanz/hgcr/issues

=== GUI ===

 * This extension has a nice Gui (based on Tortoisehg)

''Author: Boris Glimcher''

 . Repository: http://bitbucket.org/glimchb/hgcr-gui/
 . Download: http://bitbucket.org/glimchb/hgcr-gui/src/tip/hgcr-gui.py
 . Bug reports: http://bitbucket.org/glimchb/hgcr-gui/issues

=== Overview ===

 * This extension allows you to manage reviews for your code in any project you like.
 * It helps to keep the review management inside the mercurial.
 * One can add files to the review or remove them.
 * The reviewer can mark the code as 'completed' review cycle.
 * You can also check what is the review status - what is done and what is not yet.
 * The extension will automatically spot the files that were changed since their last review and notify about that.

 * Code review database is stored in .code-review file in your repository root directory as a simple text file holding a map of each file and revision when review was done.

=== Configuration ===

Download hgcr.py and configure your [[.hgrc]] or [[mercurial.ini]] to enable the extension by adding following lines:

{{{
[extensions]
filereview = /path/to/filereview.py
}}}

=== Usage ===

{{{
hg cr [OPTIONS] [FILES]
}}}

Code Review Plugin (requires Mercurial 1.1.x!)

Options:
{{{
 -c --complete  Mark CR as complete
 -a --add       Add files to CR list
 -r --remove    Remove files from CR list
 -l --list      Print files in CR list
}}}
use "hg -v help cr" to show global options


=== More Details ===

 * I've implemented the review around files and not changesets, because at the end, I want to be able to tell for the specific project if all the files went through code review process or not - the project status.

 * Suppose you have some project that you are in charge and many developers do write code for it. And there is a group of reviewrs that review the developers code.  It is very difficult to keep track of changes developers do, but simple to find out what files have already been reviewd (by reviewers) and what  were not.

 * Using this extension, Developer can mark his files (when finished development process) as "Ready for review" and send notice to reviewer. Reviewer will pick up the changeset (because changesets are stored in the code review database) and perform code review (put notes inside the developer's code). Afterwards Reviewr will mark the files as "Review Completed". and return the notice to the developer.

 * The project manager can follow every time what is going on with his/her project.

----
CategoryExtensionsByOthers