CONTRIBUTING.md

Contributing to aioswitcher

👏 First off, thank you for taking the time to contribute. 👏

Contributing is pretty straight-forward:

• Fork the repository
• Create a new branch on your fork
• Commit your changes
• Create a pull request against the dev branch

Installing

Install remote development version

Contributions are welcome in all shapes or forms. If you're a user, you can play around with the current development version and report back any findings.

Install the remote development version using pip:

pip install git+https://github.com/TomerFi/aioswitcher#dev

Install local development version

If you need to test your changes locally, you can install your work-in-progress from your active working branch.

Install the local development version using pip:

pip install --upgrade .

Developing

Prepare the development environment

With Python >= 3.10 use pip to install poetry:

  pip install -r requirements.txt

Get started with poetry

After installing, run poe for help, this will list the available tasks:

poetry install # install all dependencies and the current project
poetry run poe --help # display all available tasks

Common poe tasks:

poetry run poe test # will run all unit-tests
poetry run poe lint # will lint the project using black, flake8, isort, mypy, and yamllint
poetry run poe docs_serve # will build and serve a local version of the documentation site

Documentation

We use MkDocs and Material for building our documentation site, https://aioswitcher.tomfi.info/. See docs and mkdocs.yml.

Note

We're generating code documentation from docstrings.