This file documents ways to contribute to the MIRTK.
The MIRTK uses Github's issue tracker to record and track the list of past and present issues. Before submitting a new issue, please consider browsing this list to check whether your problem is being or has already been dealt with. Together with a meaningful title, please provide detailed instructions to help reproduce the issue. Important pieces of information include the OS, build context, execution steps and expected outcome.
Technical support may also be requested by speaking with the team directly via Gitter.
The MIRTK maintainers welcome code contributions from MIRTK users, preferrably via pull requests against the master branch. Please provide as much information as possible to help with the code review, such as why this change is needed, what it does and how to check whether the code works as intended.
If you intend to contribute your applications to the MIRTK distribution, develop your tools
either in a fork of the MIRTK Git repository or your own MIRTK Package in a separate Git repository
with the common file organization and the appropriate CMake configuration
files. See some of the already available modules in the Packages/ directory of the
MIRTK source tree as reference. Examples of MIRTK Packages are the
Deformable and
Volumetric Mapping modules,
each developed in their own respective GitHub repository.
Template files for the creation of a new MIRTK Package can be found in the
Templates directory. These template files can be customized using
the basisproject
tool of CMake BASIS, but can also
simply be copied and edited by hand. But do not copy the _conf.py file from the
Templates/mirtk-module/*/ directory.