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

Start docker containers

make up

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