hg-review documentation

hg-review is a Mercurial extension for performing distributed code review.

“Distributed code review” means you can do cool stuff like this:

hg-review overview diagram

Quickstart

If you’re impatient and want to play with hg-review right away, here’s what you need to do.

First, clone the extension somewhere:

hg clone http://bitbucket.org/sjl/hg-review/

Then add it to your ~/.hgrc file:

[extensions]
review = [path to]/hg-review/review/

Now you need a repository that has code review enabled. Luckily, you’ve already got one – hg-review uses itself for code review.

cd into the directory you cloned hg-review to and start the web interface:

cd hg-review
hg review --web

Open http://localhost:8080/ in your browser of choice and poke around. Check out the Overview when you’re ready to learn more.

Developer’s Guide

If you want to integrate hg-review with your own application or Mercurial extension, or hack on hg-review itself, this is what you need to know.