CONTRIBUTING.md

Thanks for contributing!

Branch

Create the pull request against the devel branch instead of the master.

Quality

All pull requests are welcome regardless of quality. We will work together to review and improve the pull request.

Of course there are some steps that could be considered to improve the quality of the pull request and to support the process of review and development.

• Make sure your code follows PEP 8 — Style Guide for Python Code. You can use some linting tools to automate the process (e.g. pycodestyle or flake8).
• Test your code using the existing test cases. For details read further.
• It would be great if you could create unittest's for your code.

Unittesting

This project uses Python's default unittest package. You can run all test cases via the discover feature when you run this in the projects root folder.

python3 -m unittest discover

The output should look like this

----------------------------------------------------------------------
Ran 74 tests in 0.823s

OK

If you want to run a specific test case or method you need to install the package first. It is recommended to use a virtual environment and the --editable flag of pip. Run this in the projects root folder:

python3 -m pip install --editable .

Please read further to understand the consequences of --editable.

• "pip documentation - Local project installs - Editable installs"
• "When would the -e, --editable option be useful with pip install?"

Happy coding!