Skip to content

Latest commit

 

History

History
29 lines (15 loc) · 949 Bytes

File metadata and controls

29 lines (15 loc) · 949 Bytes

Contributing

If you want to contribute to this project, please submit an issue describing your proposed change. We will respond to you as soon as we can.

If you want to work on that change, fork this Github repo and clone the fork locally. Install the requirements in a python3 virtual environment, using the appropriate version of pip:

pip install -r requirements.txt

Before submitting a PR, please ensure that:

  • you run Bandit for security checking and all checks are passing:

bandit -r .

  • you run Prospector for code analysis and all checks are passing:

prospector

  • you run Coverage and all unit tests are passing:

coverage run --source='.' -m unittest

coverage report

  • you can run the test examples like this:

python -m unittest examples.test_examples

Thanks for contributing!