Hi there! Thanks for your interest in contributing to asyncio-mqtt.
Clone the asyncio-mqtt repository.
Inside the repository, create a virtual environment:
python3 -m venv .venvActivate the virtual environment:
source .venv/bin/activateUpgrade pip:
pip install --upgrade pipInstall the development dependencies:
pip install -e .[tests,lint,format,docs]Install pre-commit so that your code is formatted and checked when you are doing a commit:
pip install pre-commit
pre-commit installIf you are using VSCode, these are workspace settings and highly recommended extensions to improve developer experience.
To test the code use pytest:
pytestTo get the full test coverage report of asyncio-mqtt, run the following command:
pytest --cov=src --cov=tests --cov-report=htmlYou can see the coverage report in htmlcov/index.html.
The documentation uses Sphinx. The source files are located in the docs folder. You can build it by running ./scripts/docs or ./scripts/docs --no-reload if you don't want to have the documentation rebuilt automatically when you change a file.
After running git commit, pre-commit will check the committed code. This check can be passed, skipped or failed.
If the check failed, it is possible that pre-commit auto-fixed the code, so you only need to re-stage and re-commit. If it did not auto-fix the code, you will need to do so manually.
pre-commit will only check the code that is staged, the unstaged code will be stashed during the checks.
The branch to contribute is main. You can create a draft pull request as long as your contribution is not ready. Please also update the CHANGELOG.md with the changes that your pull request makes!