Home

CodeReview Extension

This extension is distributed with TortoiseHg >= 0.9

based on non-gui simple version from http://bitbucket.org/romanz/hgcr

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.
  • The notification to reviewer about new files for review and notifications for developer about current review round finish are also managed by this tool through email just by 1-Click
  • 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

Windows

configure your mercurial.ini to enable the extension by adding following lines:

[extensions]
hgext.hgcr-gui-qt =

Linux

Download hgcr-gui-qt.py and configure your .hgrc to enable the extension by adding following lines:

[extensions]
hgcr-gui-qt = /path/to/hgcr-gui-qt.py

Commandline Usage

hg cr [OPTIONS] [FILES]

Code Review Plugin (requires Mercurial 1.3.x and TortoiseHg 0.9)

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
 -d --developer Change the file developer
 -w --reviewer  Change the file reviewer
 -m --mail      Send mail

use "hg -v help cr" to show global options

GUI Usage

hg cr

Note: add here more explanation and maybe event screenshots....

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. Is 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.

FAQ

Frequently Asked Questions

Updated

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.