Skip to content

Fix #214 -- Update contributing guilde #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 5, 2023
Merged

Fix #214 -- Update contributing guilde #216

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions CONTRIBUTING.rst
View file
Open in desktop
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