Code quality check improvements

datakind · May 8, 2024 · 474e881 · 474e881
1 parent 599e9c0
commit 474e881
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/CONTRIBUTION.md 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`