ITK/Release 4/Global Code Review/Procedure: Difference between revisions
From KitwarePublic
< ITK | Release 4 | Global Code Review
Jump to navigationJump to search
No edit summary |
Daviddoria (talk | contribs) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
* A parallel Git repository has been created. | * A parallel Git repository has been created. | ||
** https://github.com/InsightSoftwareConsortium/itk-retroactive-review | |||
* It contains empty text files for every ITK source code file | * It contains empty text files for every ITK source code file | ||
* As developers review every source file, comments and observations will be registered in the text files of the parallel Git repository. | * As developers review every source file, comments and observations will be registered in the text files of the parallel Git repository. | ||
== | = Particular Cases = | ||
== Review Directory == | |||
* The review directory will be separated from the toolkit | |||
* It will be managed as an External module temporarily | |||
* Commonly used classes from Review | |||
** Will be prioritized for code reviews and | |||
** Will be moved to their final destination in the toolkit | |||
An important goal in this case, is to make less common (actually make very rare) that users have to turn the full Review directory on, just to get some classes out of it. We will identify the useful classes, clean them up, fit them up to ITK standards, and move them to a permanent module inside of the toolkit. | |||
== ITKv4 Code Review Process == | |||
* [[ITK_Release_4/Modularization/Code Reviews/Process|Suggested Processes]] | * [[ITK_Release_4/Modularization/Code Reviews/Process|Suggested Processes]] | ||
Latest revision as of 16:02, 9 December 2011
Procedure
- A parallel Git repository has been created.
- It contains empty text files for every ITK source code file
- As developers review every source file, comments and observations will be registered in the text files of the parallel Git repository.
Particular Cases
Review Directory
- The review directory will be separated from the toolkit
- It will be managed as an External module temporarily
- Commonly used classes from Review
- Will be prioritized for code reviews and
- Will be moved to their final destination in the toolkit
An important goal in this case, is to make less common (actually make very rare) that users have to turn the full Review directory on, just to get some classes out of it. We will identify the useful classes, clean them up, fit them up to ITK standards, and move them to a permanent module inside of the toolkit.
