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

Install remote development version

Contributions are welcome in all shapes or forms. If you're a user, you can play around with the current version in development and report back if you bump into anything suspicious.

Install remote development version using pip:

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

Install local development version

In order to test your changes you can install the current development version from your active working branch.

Install local development version using pip:

pip install --upgrade .

Prepare the environment

With Python >= 3.10 use pip to install poetry:

  pip install -r requirements.txt

Get started

Note the code documentation, hosted in this project's documentation site.

Get started using poethepoet

If you prefer using Python's poethepoet, here are some scripts to get you started:

poetry run poe install # install all dependencies and the current project
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

Get started using make

If you prefer using GNU's make, here are some targets to get you started:

make install # install all dependencies and the current project
make test # will run all unit-tests
make lint # will lint the project using black, flake8, isort, mypy, and yamllint
make docs-serve # will build and serve a local version of the documentation site