Difference between revisions of "ITK/Gerrit/ReviewPrimer"

From KitwarePublic
< ITK‎ | Gerrit
Jump to navigationJump to search
Line 8: Line 8:
 
==Select an open change==
 
==Select an open change==
 
The primary review site for Gerrit/ITK is [http://review.source.kitware.com http://review.source.kitware.com].  From this page, changes may be reviewed, etc.  Our review will be of [http://review.source.kitware.com/79 Change I5e76253f: Removed unecessary commented out debugging code] commited on Sept. 17, 2010.  Because Gerrit is dynamic, this primer will include many screenshots, [http://www.urbandictionary.com/define.php?term=YMMV YMMV].
 
The primary review site for Gerrit/ITK is [http://review.source.kitware.com http://review.source.kitware.com].  From this page, changes may be reviewed, etc.  Our review will be of [http://review.source.kitware.com/79 Change I5e76253f: Removed unecessary commented out debugging code] commited on Sept. 17, 2010.  Because Gerrit is dynamic, this primer will include many screenshots, [http://www.urbandictionary.com/define.php?term=YMMV YMMV].
 +
 +
The screen below is from Gerrit and contains several sections of interest.
 +
 +
'''A''' This section gives details of the change author (Hans Johnson), project(ITK), destination branch (master), topic (removeUnnecessaryComments), dates and status.<br>
 +
'''B''' This section is the commit message.  The [http://who-t.blogspot.com/2009/12/on-commit-messages.html standard format] for a commit is a single line summary, blank line, and longer description of the change.
 +
'''C''' This section gives the details of the reviewers.  A developer may request certain registered developers as reviewers for the change, and any Gerrit registered user may comment.
 +
'''D''' This section gives details on the submitted code. It provides details on how to pull the changes from Gerrit.  At the bottom is a list of files changed and links to diffs.
  
 
[[File:ReviewOverview.png]]
 
[[File:ReviewOverview.png]]
 +
 +
==Review steps==
 +
 +
* Review the code in Gerrit
 +
* Use git to pull the changes
 +
* Build, test, review locally
 +
* Optionally, modify the commit and push changes back into Gerrit for review
 +
* Score the change with comments
 +
* If the change is ready, push it into the official repository

Revision as of 08:33, 21 September 2010

Gerrit code reviews can be relatively straightforward, but also give the reviewer a chance to look deep into proposed changes building and testing those changes locally. This primer is intended to guide the reader through the process of a deep review of a code change.

Prerequisites

This primer assumes a working knowledge of how to build ITK. No details will be given as to how to build and test the code (but they can be found here). This primer also assumes a working knowledge of git. Please see the ITK git pages and/or git books (ProGit, Community Book, or Version Control withGit).

Also required is a Gerrit change to review. We will go through a real life code review of a change submitted to Gerrit.

Select an open change

The primary review site for Gerrit/ITK is http://review.source.kitware.com. From this page, changes may be reviewed, etc. Our review will be of Change I5e76253f: Removed unecessary commented out debugging code commited on Sept. 17, 2010. Because Gerrit is dynamic, this primer will include many screenshots, YMMV.

The screen below is from Gerrit and contains several sections of interest.

A This section gives details of the change author (Hans Johnson), project(ITK), destination branch (master), topic (removeUnnecessaryComments), dates and status.
B This section is the commit message. The standard format for a commit is a single line summary, blank line, and longer description of the change. C This section gives the details of the reviewers. A developer may request certain registered developers as reviewers for the change, and any Gerrit registered user may comment. D This section gives details on the submitted code. It provides details on how to pull the changes from Gerrit. At the bottom is a list of files changed and links to diffs.

ReviewOverview.png

Review steps

  • Review the code in Gerrit
  • Use git to pull the changes
  • Build, test, review locally
  • Optionally, modify the commit and push changes back into Gerrit for review
  • Score the change with comments
  • If the change is ready, push it into the official repository