Contributing

So excited to have you here! If you want any guidance whatsoever, don't hesitate to reach out on Discord!

Run the tests

The first step is clone DisCoPy and install it locally.

git clone https://github.com/discopy/discopy.git
cd discopy
pip install .

Then you should check you haven't broken anything by running the test suite:

pip install ".[test]" .
coverage run -m pytest --doctest-modules --pycodestyle
coverage report -m discopy/*.py discopy/*/*.py

You can build the documentation locally with sphinx:

pip install ".[docs]" .
sphinx-build docs docs/_build/html