Skip to content

Commit

Permalink
Update contributing statements.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexzwanenburg committed Apr 4, 2024
1 parent 897adff commit b559ab2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/oncoray/mirp/issues>`_ 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.
Expand All @@ -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.
8 changes: 4 additions & 4 deletions docs_source/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
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.
MIRP 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 <https://github.com/oncoray/mirp/issues>`_ 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.
Expand Down

0 comments on commit b559ab2

Please sign in to comment.