List of contributors

The following is an alphabetically sorted list of people that have contributed to this project.

Name

Institution

Contributions

Ben Cox

University College London

MATLAB API

Kris Dreher

German Cancer Research Center

IO Handling

Janek Gröhl

University of Cambridge

General Maintenance; Python API

Lina Hacker

University of Cambridge

Python API

François Varray

Creatis, Université de Lyon

MATLAB API

Jeffrey Sackey

University College London

MATLAB API

Lawrence Yip

Lawson Health Research Institute

Adapter Implementation, Bug Fixing

How to contribute

We welcome any forms of contributions to the project! If you are unsure how to contribute, contact either Ben Cox, Lina Hacker, or Janek Gröhl (@jgroehl) for guidance. Before contributing you should be aware of some boundary conditions that are outlined here:

License

The project is licensed under the BSD 3-Clause License. Every contributor has to make their contributions available under the same license. Including materials from other licenses is only possible, if the respective license is compatible with the BSD 3-Clause License.

Developer’s Certificate of Origin

When contributing to the project, you agree to the following terms, stating that you have indeed the right to contribute the code under the MIT license and that you acknowledge that the contributed code will be and remain publically available.

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

To validate that you agree with these terms, please sign off the last commit before your pull request, by adding the following line to the commit message:

Signed-off-by: Random J Developer <random@developer.example.org>

This is a built-in feature of git and you can automate this by using the -s flag.

Coding conventions

We ask all contributors to follow a couple of conventions and best pratices when contributing code:

  • Code is formatted according to the Python PEP-8 coding standard.

  • Contributors create a test case that tests their code.

  • Contributors document their code.

Practical Workflow

Contributors open issue and create implementation on a separate branch or fork. Any open questions / calls for help are addressed via a meeting taking place every second week or the comment function in the issue. Once the contributor is happy with their code they sign-off the last commit and open a pull request.