Skip to content

Commit

Permalink
Fix #214 -- Update contributing guilde
Browse files Browse the repository at this point in the history
  • Loading branch information
codingjoe committed May 5, 2023
1 parent 0dc2e77 commit c309742
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit c309742

Please sign in to comment.