Permalink
Fetching contributors…
Cannot retrieve contributors at this time
40 lines (27 sloc) 917 Bytes

Contributing

Testing

We are using pytest, pylint, and tox for testing. To run simple tests: python setup.py test. To run full tests:

pip install tox
tox

Make sure you have followed all the steps before submitting your PR.

Before submitting

Before submitting your code please do the following steps:

  1. Run tox to make sure everything was working before
  2. Add any changes you want
  3. Adds tests for the new changes
  4. Edit documentation if you have changed something significant
  5. Run tox again to make sure it is still working

Other help

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. What are your best-practices?

Authors

Do not forget to add yourself into AUTHORS.rst.