Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

18 lines (15 loc) · 1.33 KB

Contributing

IRP is open-source software, hosted on GitHub. Contributions that enable new DICOM modalities are especially welcome! If you have ideas or code to contribute, please first open an issue <https://github.com/oncoray/mirp/issues>_ and describe your ideas.

Technical documentation is forthcoming. For now, please keep the following in mind when contributing:

  • The main branch of mirp is protected. You can therefore make a pull request for your contribution to a development branch of the intended future version.
  • If you introduce new functionality, this functionality should be tested as part of the tests in the test directory. After implementation, please ensure that all tests complete without errors by running pytest from your IDE or console using python -m pytest test from the mirp main directory.
  • Code is styled according to PEP8. Using a linter or IDE with automated linter is recommended.
  • Function, class and method documentation is done using Numpy-flavoured docstrings. Long-form documentation is partially created from function, class and method documentation, embedded in restructured text files in the docs_source directory.