Difference between revisions of "ITK/Procedure for Contributing New Classes and Algorithms"

From KitwarePublic
< ITK
Jump to navigationJump to search
 
Line 1: Line 1:
 +
= Introduction =
 +
 
This page describes the procedure for contributing new algorithms and classes to the Insight Toolkit.
 
This page describes the procedure for contributing new algorithms and classes to the Insight Toolkit.
 +
 +
= The Rationale =
  
 
The rationale behind this procedure is to pursue the following goals
 
The rationale behind this procedure is to pursue the following goals
Line 16: Line 20:
 
Since some of these goals may be conflicting, it will be the prerrogative of the Oversight Committee to rule on whether one criteria should be given more importance over another one.
 
Since some of these goals may be conflicting, it will be the prerrogative of the Oversight Committee to rule on whether one criteria should be given more importance over another one.
  
 +
 +
= The Procedure =
  
 
The procedure for contributing new classes and algorithms is the following.
 
The procedure for contributing new classes and algorithms is the following.
  
 
# An Author will propose an algorithm to the developers list or to the weekly tcon.<br>This
 
# An Author will propose an algorithm to the developers list or to the weekly tcon.<br>This

Revision as of 10:51, 2 December 2005

Introduction

This page describes the procedure for contributing new algorithms and classes to the Insight Toolkit.

The Rationale

The rationale behind this procedure is to pursue the following goals

  1. Technical correctness of new contributions
  2. Avoid duplication of functionalities
  3. Maximize reuse of existing code
  4. Maximize generalization of the algorithm implementations
  5. Enforce validation, testing and code coverage
  6. Maximize maintainability
  7. Ensure that new algorithms are properly documented
  8. Gather feedback from the community
  9. Hold a continuously open forum where algorithmic, and performance issues are discussed.


Since some of these goals may be conflicting, it will be the prerrogative of the Oversight Committee to rule on whether one criteria should be given more importance over another one.


The Procedure

The procedure for contributing new classes and algorithms is the following.

  1. An Author will propose an algorithm to the developers list or to the weekly tcon.
    This