Contributing¶
Basic Instructions¶
- Fork and clone the repository.
- Setup your python environment using virtualenv or you can use our docker-compose.yml if you are familiar with docker-compose.
- Code!
- Run the tests via python setup.py test or via docker-compose using make test command.
- Write tests for the changes you made, coverage must be above 95%.
- Write browser tests if suitable, test via pytest tests/test_browser.py or via make test-browser command (These tests are not executed on Travis CI, so they need to be tested before committing and pushing).
- Check if your new code follow standards Code standards.
- Commit, push and open a new Pull Request.
Code standards¶
We follow PEP8 as much as possible except for max-line-length = 99 and we recommend the linters:
- flake8
- flake8-quotes plugin
Versioning¶
This project adheres to Semantic Versioning.