ITK/Release 4/Modularization/Code Reviews/Process: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(Created page with "= Overview = * Define a comma separated file per contractor * Containing ** Filename ** Outcome = Possible Outcomes = For each file, a contractor will review the code followin...")
 
Line 11: Line 11:


* No change required (key: Good)
* No change required (key: Good)
* Minor typos (key: Minor)
* Minor typos (key: Minor)(reviewer will fix them directly)
* Doxygen documentation needed (need fixing) (key: Dox)
* Doxygen documentation needed (need fixing) (key: Dox)
* File must be removed (broke, obsolete, irreparable) (key: Kill)
* File must be removed (broke, obsolete, irreparable) (key: Kill)
* File needs refactoring (key: BUG#number)(it must have been logged as a mantis bug by the time the CSV file is updated)
* File needs refactoring (key: BUG#number)(it must have been logged as a mantis bug by the time the CSV file is updated)


= Contractors =
= Contractors =

Revision as of 15:32, 15 February 2011

Overview

  • Define a comma separated file per contractor
  • Containing
    • Filename
    • Outcome

Possible Outcomes

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

  • No change required (key: Good)
  • Minor typos (key: Minor)(reviewer will fix them directly)
  • Doxygen documentation needed (need fixing) (key: Dox)
  • File must be removed (broke, obsolete, irreparable) (key: Kill)
  • File needs refactoring (key: BUG#number)(it must have been logged as a mantis bug by the time the CSV file is updated)

Contractors

Refactoring

For classes to be refactored

the following process should be followed

  • MANTIS Bug
  • Dependencies
  • Migration guide