Skip to content

Commit

Permalink
Added contributing section to long-form documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexzwanenburg committed Apr 3, 2024
1 parent f8d0d8e commit af7accb
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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.
- 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](https://peps.python.org/pep-0008/). Using a linter or IDE with automated linter
Expand Down
21 changes: 21 additions & 0 deletions docs_source/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Contributing
============

MIRP is open-source software, hosted on `GitHub <https://github.com/oncoray/mirp>`_. If you have ideas or code to
contribute, please first open an `issue <https://github.com/oncoray/mirp/issues>`_. We will then discuss your ideas
and create an implementation roadmap.

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. Likewise existing automated tests should
pass.
* Code is styled according to `PEP8 <https://peps.python.org/pep-0008/>`_. Using a linter or IDE with automated linter
is recommended.
* Function, class and method documentation is done using Numpy-flavoured
`docstrings <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
`Long-form documentation <https://oncoray.github.io/mirp/>`_ is partially created from function, class and method
documentation, embedded in restructured text files in the ``docs_source`` directory.
8 changes: 8 additions & 0 deletions docs_source/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ Welcome to MIRP
mask_labels
deep_learning
quantitative_image_analysis
contributing

What is radiomics?
------------------


What is MIRP?
-------------

Medical Image Radiomics Processor (MIRP) is an IBSI-compliant [Zwanenburg2020]_, [Whybra2024]_ python package for
medical image analysis. MIRP focuses on radiomics applications and supports computation of features for conventional
Expand Down

0 comments on commit af7accb

Please sign in to comment.