So you want to help, excellent! Here's some guidelines to follow.
We're always looking for help with documentation, bug fixes, support for more devices, and even new features.
- Fork the develop branch as a start.
- Run tests using tox and verify that they pass.
- Write code tests for bug you are fixing or feature you are adding.
- Write code to fix the bug or add a feature.
- Document code using Sphinx-autodoc syntax.
- Re-run tox and make sure all tests pass.
- Submit a pull request. Be sure to fully document the bug/fix or feature in the pull request.
All code must follow pep8 style guides, and will be checked with flake8.
Any new code added must be tested by a unit test.
Any new code added must have the appropriate sphinx autodoc syntax.