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/nhs-aws-helpers
asdf plugin add python
asdf plugin add poetry
asdf install

install git hooks

make refresh-hooks

normal development

create virtualenv and install python dependencies

make install
source .venv/bin/activate

running tests

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 formaated correctly

# make black will run both isort and black
make black