From b559ab20f2ceba16ba0dc00e49bed4e7e7735ea9 Mon Sep 17 00:00:00 2001 From: Alex Zwanenburg Date: Thu, 4 Apr 2024 16:37:42 +0200 Subject: [PATCH] Update contributing statements. --- CONTRIBUTING.md | 10 ++++++---- docs_source/source/contributing.rst | 8 ++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a60dc1a..2d686de7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,10 @@ -# How to contribute +# Contributing -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. +IRP is open-source software, hosted on [GitHub](https://github.com/oncoray/mirp). Contributions that enable +new DICOM modalities are especially welcome! If you have ideas or code to contribute, please first open an +`issue `_ and describe your ideas. -Please keep the following in mind when contributing: +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. @@ -13,4 +15,4 @@ Please keep the following in mind when contributing: 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 `docs_source`. + documentation, embedded in restructured text files in the `docs_source` directory. diff --git a/docs_source/source/contributing.rst b/docs_source/source/contributing.rst index 5c48fbf3..072af046 100644 --- a/docs_source/source/contributing.rst +++ b/docs_source/source/contributing.rst @@ -1,11 +1,11 @@ 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. +MIRP 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 `_ and describe your ideas. -Please keep the following in mind when contributing: +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.