ITK/Rules for CVS Contributors

From KitwarePublic
Jump to navigationJump to search

This page is intended for developers who have gained CVS write access to the toolkit.

It collects many of the behavior guidelines that have been developed in the ITK community over the years. By stating the rules here we are hopping to make easier for new CVS contributor to know how to perform different tasks.

Tools

Developers are expected to become familiar with the following tools:

  • KWStyle
  • Doxygen
  • CVS
  • MANTIS bug tracker
  • CMake
    • CTest
  • patch / cvs diff

Release Process

ITK is released every four months.

The release process involves

  1. Select contributions from the Insight Journal
  2. Move them to the Code/Review directory
  3. Select code that has been in the Review directory for more than one release and move it to its permanent location.


Freezing

The freezing process involves removing CVS write access from the majority of developers and reducing the active writers to 3 or 4 developers.

During the freezing period, only bug fixes are supposed to be added to the code in the repository.

Contributing New Classes

New classes are contributed through the Insight Journal

Developers with CVS write access should not commit new files to the toolkit directly. All new classes must be submitted first as contributions to the Insight Journal

Release Branches

The latest release is managed in the Git repository on the release branch. Thanks to Git anyone can check out this branch locally and create commits to fix bugs. See the ITK Git page section on how to contribute a Release Bug Fix. Bug fix topics should be started on the release branch but merged to the master branch. A release manager will handle merging the topic back to the release branch.