Something that will be nice to have, and helps a lot in development, is the user of pre-commit and pre-commit hooks to perform local linting and checks while you're working on a PR. At the moment, there isn't much code in the project so this might seem like overkill, but it helps considerably once projects scale up.
It would be nice to have:
A dev-requirements.txt file that has tooling that will be helpful to install if doing dev work (so to start off with just) (note here it doesn't matter as much the pinning to versions)
Something that will be nice to have, and helps a lot in development, is the user of
pre-commit
andpre-commit
hooks to perform local linting and checks while you're working on a PR. At the moment, there isn't much code in the project so this might seem like overkill, but it helps considerably once projects scale up.It would be nice to have:
dev-requirements.txt
file that has tooling that will be helpful to install if doing dev work (so to start off with just) (note here it doesn't matter as much the pinning to versions)A
.pre-commit-config.yaml
to contain the pre-commit hooks. c.f. https://scikit-hep.org/developer/style#pre-commit andpyhf
's.pre-commit-config.yaml
for an exampleSetup https://pre-commit.ci/ for the repo so that it the hooks will get run in CI on PRs as well.