CONTRIBUTING.md

Contributing

dependencies

tools used:

• make
• git
• asdf version manager

first run ...

install project tools

use asdf to ensure required tools are installed ... configured tools are in .tool-versions

cd ~/work/mesh-client
asdf plugin add python
asdf plugin add poetry
asdf plugin add terraform
asdf plugin add tfsec
asdf install

install git hooks

make refresh-hooks

normal development

create virtualenv and install python dependencies

make install
source .venv/bin/activate

running tests

start the mesh-sandbox docker container

make up

make test

testing multiple python versions

to test all python versions configured

make tox

linting

project uses:

• ruff
• mypy

run both with

make lint

or individually with

make mypy

or

make ruff 

formatting code

project uses:

• black

lint checks will fail if the code is not formatted correctly

make black

secrets

the git-secrets script will try and avoid accidental committing of secrets patterns are excluded using .gitdisallowed and allow listed using .gitallowed if the git hooks are registered make refresh hooks then secrets will be scanned for in the pre-commit hook. You can check for secrets / test patterns at any time though with

make check-secrets-all