Skip to content

Commit

Permalink
Style hints for contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
TheChymera committed Feb 24, 2023
1 parent 3e94145 commit 5bf16a3
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,11 @@ rules before submitting a pull request:

* All public functions (i.e. functions whose name does not start with an underscore) should have
informative docstrings with sample usage presented as doctests when appropriate.
.. code-block:: sh
cd /path/to/your/clone/of/heudiconv
pytest -vvs .
* Docstrings are formatted in `NumPy style <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
* Lines are no longer than 120 characters.
* All tests still pass::

cd /path/to/your/clone/of/heudiconv
pytest -vvs .

* All other tests pass:
* New code should be accompanied by new tests.

0 comments on commit 5bf16a3

Please sign in to comment.