CONTRIBUTING.md

Development setup

Configure python environment

In order to assure that the files contained here are linted the same way, we are using pyenv.

Follow Installing and using pyenv, or, in short:

pyenv install 3.8.12
pyenv virtualenv 3.8.12 role-name

Configure ansible environment

You will need Ansible on your machine to run the playbooks, follow the steps below to install it.

pyenv exec pip install -r requirements.txt
ansible-galaxy install -r requirements.yml -f

Install pre-commit hooks

We use pre-commit framework to assure quality code.

pre-commit install