From 5d16da1ddda4c694335437540e5ecddf899e5355 Mon Sep 17 00:00:00 2001 From: Melissa DeLucchi Date: Mon, 26 Jan 2026 14:47:05 -0500 Subject: [PATCH] Add pointers when adding a new hook --- src/pre_commit_hooks/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 src/pre_commit_hooks/README.md diff --git a/src/pre_commit_hooks/README.md b/src/pre_commit_hooks/README.md new file mode 100644 index 0000000..9d8d4d2 --- /dev/null +++ b/src/pre_commit_hooks/README.md @@ -0,0 +1,19 @@ +# Adding new hooks + +This repository can be used for adding new pre-commit hooks, mostly +that are related to functionality offered by the LINCC Frameworks +Python Project Template. + +## Checklist + +* Write tests for your new hook +* Implement the hook logic in a new module in this directory +* Make sure that the module contains a `if __name__ == "__main__":` kinda thing +* Include the module in the `./src/__init__.py` file +* Add an entry in the `./.pre-commit-hooks.yaml` file +* Add an entry to `./pyproject.toml` in the `[project.scripts]` section +* Add documentation on the main README to explain + * the purpose of the hook + * how to add the hook to your project + * what pre-commit success looks like + * what pre-commit failures look like \ No newline at end of file