Received-SPF: pass (sog-mx-3.v43.ch3.sourceforge.com: domain of gmail.com
	designates 209.85.214.54 as permitted sender)
	client-ip=209.85.214.54; envelope-from=mh.in.england@gmail.com;
	helo=mail-bk0-f54.google.com; 
MIME-Version: 1.0
Sender: mh.in.england@gmail.com
Date: Fri, 4 Oct 2013 12:30:07 +0200
Message-ID: <CANEZrP1Sd8cK2YUr4OSvnOxEJrbWpmfdpor-qbap1f98tGqPwg@mail.gmail.com>
From: Mike Hearn <mike@plan99.net>
To: Bitcoin Dev <bitcoin-development@lists.sourceforge.net>
Content-Type: multipart/alternative; boundary=001a11334a3c478b9004e7e7c903
Subject: [Bitcoin-development] Code review
Precedence: list

--001a11334a3c478b9004e7e7c903
Content-Type: text/plain; charset=UTF-8

Git makes it easy to fork peoples work off and create long series of
commits that achieve some useful goal. That's great for many things.
Unfortunately, code review is not one of those things.

I'd like to make a small request - when submitting large, complex pieces of
work for review, please either submit it as one giant squashed change, or
be an absolute fascist about keeping commits logically clean and separated.
It really sucks to review things in sequence and then discover that some
code you spent some time thinking about or puzzling out got
deleted/rewritten/changed in a later commit. It also can make it harder to
review things when later code uses new APIs or behaviour changes introduced
in earlier commits - you have to either keep it all in your head, do lots
of tab switching, or do a squash yourself (in which case every reviewer
would have to manually do that).

On a related note, github seems to have lost the plot with regards to code
review - they are spending their time adding 3D renderers to their diff
viewer but not making basic improvements other tools had for years.

So, I'd like to suggest the idea of using Review Board:

http://www.reviewboard.org/

It's an open source, dedicated code review tool used by lots of big name
companies for their internal work. It has git[hub] integration and a lot of
very neat features, like the ability to attach screenshots to reviews. Also
more basic ones, like side by side diffs. Branches can be and often are
submitted to the system as single reviews.

The company behind it (disclosure - written and run by a long time friend
of mine) offers hosting plans, but we could also host it on a Foundation
server instead.

--001a11334a3c478b9004e7e7c903
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Git makes it easy to fork peoples work off and create long=
 series of commits that achieve some useful goal. That&#39;s great for many=
 things. Unfortunately, code review is not one of those things.<div><br></d=
iv>
<div>I&#39;d like to make a small request - when submitting large, complex =
pieces of work for review, please either submit it as one giant squashed ch=
ange, or be an absolute fascist about keeping commits logically clean and s=
eparated. It really sucks to review things in sequence and then discover th=
at some code you spent some time thinking about or puzzling out got deleted=
/rewritten/changed in a later commit. It also can make it harder to review =
things when later code uses new APIs or behaviour changes introduced in ear=
lier commits - you have to either keep it all in your head, do lots of tab =
switching, or do a squash yourself (in which case every reviewer would have=
 to manually do that).</div>
<div><br></div><div>On a related note, github seems to have lost the plot w=
ith regards to code review - they are spending their time adding 3D rendere=
rs to their diff viewer but not making basic improvements other tools had f=
or years.</div>
<div><br></div><div>So, I&#39;d like to suggest the idea of using Review Bo=
ard:</div><div><br></div><div><a href=3D"http://www.reviewboard.org/">http:=
//www.reviewboard.org/</a><br></div><div><br></div><div>It&#39;s an open so=
urce, dedicated code review tool used by lots of big name companies for the=
ir internal work. It has git[hub] integration and a lot of very neat featur=
es, like the ability to attach screenshots to reviews. Also more basic ones=
, like side by side diffs. Branches can be and often are submitted to the s=
ystem as single reviews.</div>
<div><br></div><div>The company behind it (disclosure - written and run by =
a long time friend of mine) offers hosting plans, but we could also host it=
 on a Foundation server instead.</div><div><br></div><div><br></div></div>

--001a11334a3c478b9004e7e7c903--