CONTRIBUTING.md

Contributing guide

1. Keep it unit tested, so that coverage doesn't fall down too much.
2. Exhaustive pydoc. Remember to update the docs/.
3. If you introduce any gotchas, document them in docs/.
4. We aim to support Python 2.7 as long as possible, keep that in account.

Unit tests

Tests work using docker-compose.

Just

docker-compose up --build unittest
docker-compose up --build stress_tests

If you want to debug things, please install a RabbitMQ instance via Docker, expose the necessary ports and go from there.

If you want to see a coverage report, run tests like this:

nosetests --with-coverage --exe
coverage html

and then go to http://127.0.0.1:8765