diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8008360..9a60dc1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/docs_source/source/contributing.rst b/docs_source/source/contributing.rst new file mode 100644 index 00000000..5c48fbf3 --- /dev/null +++ b/docs_source/source/contributing.rst @@ -0,0 +1,21 @@ +Contributing +============ + +MIRP is open-source software, hosted on `GitHub `_. If you have ideas or code to +contribute, please first open an `issue `_. 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 `_. 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. diff --git a/docs_source/source/index.rst b/docs_source/source/index.rst index b5677ec8..998f0ed9 100644 --- a/docs_source/source/index.rst +++ b/docs_source/source/index.rst @@ -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