I really like this repo, however there is no guide for contributors. This PR adds a section to the README with a guide on how to setup a local development environment and how to run the integration tests locally. In addition, in order to maintain standard formatting and linting conventions, pre-commit is introduced with black and isort. The GitHub workflows now reflect this change, instead of calling just black, pre-commit is run, this will enable adding further hooks in the future (if desired).
I really like this repo, however there is no guide for contributors. This PR adds a section to the
README
with a guide on how to setup a local development environment and how to run the integration tests locally. In addition, in order to maintain standard formatting and linting conventions,pre-commit
is introduced withblack
andisort
. The GitHub workflows now reflect this change, instead of calling justblack
,pre-commit
is run, this will enable adding further hooks in the future (if desired).