From c3097428ae343d001cef7fd2b5d524f6af0e90f6 Mon Sep 17 00:00:00 2001 From: Johannes Maron Date: Fri, 5 May 2023 17:34:25 +0200 Subject: [PATCH] Fix #214 -- Update contributing guilde --- CONTRIBUTING.rst | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d3ccb2e0..edec7794 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,17 +1,27 @@ Contributing ============ -This package uses the pyTest test runner. To run the tests locally simply run:: +Before you start editing the python code, you will need to make sure +you have binary dependencies installed:: - python setup.py test + # Debian + sudo apt install -y gettext graphviz google-chrome-stable + # macOS + brew install -y gettext graphviz google-chrome-stable -If you need to the development dependencies installed of you local IDE, you can run:: +To install the package and its dependencies for development +including tests dependencies, please do: - python setup.py develop + python -m pip install -e .[test] + +You may ran the tests via:: + + python -m pytest Documentation pull requests welcome. The Sphinx documentation can be compiled via:: - python setup.py build_sphinx + python -m pip install -e .[docs] + python -m sphinx -W -b doctest -b html docs docs/_build Bug reports welcome, even more so if they include a correct patch. Much more so if you start your patch by adding a failing unit test, and correct