Revision as of 15:48, 15 February 2011

Overview

Kitware will create a separate Git repository containing
- One text file for each one of the files in the current ITK Manifest.
- The files will be named after the ITK files. For example
  - itkImage.h.txt will be the code review file for itkImage.h
The repository will contain at the top level, one directory per contractor, and under that directory we will replicate the monolithic directory tree structure of ITK with only the files that have been assigned to that contractor.
This text files will be populated by the code reviewers with the following standardize content

  STATUS: StatusKey (see table below)
  
  Arbitrary texts, as detailed as the reviewer deem necessary. it could be paragraphs.

For each file, a contractor will review the code following the Check list (reference here) and specify one of the following potential status

Pending: No review has been performed yet.
Good: The file has been reviewed, and no change was required.
Minor: Minor typos. In this case the reviewer will fix the problems directly (and still submit them to Gerrit). Minor changes are defined a those that do not influence the API. (including doxygen documentation).
Major: File needs refactoring or major bug fixing. The reviewer must log a mantis and include the Bug number in the comments in the .txt review file.
Remove: File must be removed (broke, obsolete, irreparable).

For classes to be refactored

the following process should be followed

@@ Line 12: / Line 12: @@
     Arbitrary texts, as detailed as the reviewer deem necessary. it could be paragraphs.
-= Possible Outcomes =
+= Status Keys =
-For each file, a contractor will review the code following the Check list (reference here) and specify one of the following outcomes
+For each file, a contractor will review the code following the Check list (reference here) and specify one of the following potential status
-* No change required (key: Good)
+* '''Pending''': No review has been performed yet.
-* Minor typos (key: Minor)(reviewer will fix them directly)
+* '''Good''': The file has been reviewed, and no change was required.
-* Doxygen documentation needed (need fixing) (key: Dox)
+* '''Minor''': Minor typos. In this case the reviewer will fix the problems directly (and still submit them to Gerrit). Minor changes are defined a those that do not influence the API. (including doxygen documentation).
-* File must be removed (broke, obsolete, irreparable) (key: Kill)
+* '''Major''': File needs refactoring or major bug fixing. The reviewer must log a mantis and include the Bug number in the comments in the .txt review file.
-* File needs refactoring (key: BUG#number)(it must have been logged as a mantis bug by the time the CSV file is updated)
+* '''Remove''': File must be removed (broke, obsolete, irreparable).
 = Contractors =