Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.11 KB

CONTRIBUTING.rst

File metadata and controls

52 lines (34 loc) · 1.11 KB

How to contribute

Submitting bug reports

If you want to report a bug you can use the repository's issue tracker or you can contact us directly by email; the latter should be preferred if you want to report a security vulnerability.

Contributing code

# clone the repo
git clone https://github.com/kabelwerk/sdk-python
cd sdk-python

# create a virtual env
# the venv dir is git-ignored
python3 -m venv venv
source venv/bin/activate

# install the dependencies
# you can also pip install -r requirements.txt
pip install pip-tools
pip-sync

# run the unit tests
pytest

Conventions

For file encoding, newlines, indentation: please use the .editorconfig rules (take a look here if this is new for you).

For coding style: please follow PEP8.