-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added contributing section to long-form documentation.
- Loading branch information
1 parent
f8d0d8e
commit af7accb
Showing
3 changed files
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters