From 474e88129d49c1dd69f53975d142c95c70aa2f97 Mon Sep 17 00:00:00 2001 From: Matthew Harris Date: Wed, 8 May 2024 15:35:55 -0400 Subject: [PATCH] Code quality check improvements --- CONTRIBUTION.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 CONTRIBUTION.md diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 00000000..19797fcd --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,9 @@ +# Development + +## Pre-commit hooks + +The repo has been set up with black and flake8 pre-commit hooks. These are configured in the ``.pre-commit-config.yaml` file and initialized with `pre-commit autoupdate`. + +On a new repo, you must run `pre-commit install` to add pre-commit hooks. + +To run code quality tests, you can run `pre-commit run --all-files` \ No newline at end of file