remove .githooks/pre-commit and update documentation on how to set up…

… the pre-commit hooks
lanl · Jan 30, 2025 · 03a77a1 · 03a77a1
1 parent 70a6d8d
commit 03a77a1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 25 deletions.
diff --git a/.githooks/pre-commit b/.githooks/pre-commit
diff --git a/docs/sphinx/contribute.rst b/docs/sphinx/contribute.rst
@@ -14,13 +14,11 @@ Upon release, develop will be merged by the team lead into main. Additionally, a
 
 Style Guide
 ===========
-BEE is python code and adheres to style guidelines specified in **setup.cfg**, enforced using `pylint <https://pylint.readthedocs.io/en/v3.2.7/#>`_. Before attempting to commit and push changes, please install our pre-commit githooks by running the following command in project root:
+BEE is python code and adheres to style guidelines specified in **setup.cfg**, enforced using `pylint <https://pylint.readthedocs.io/en/v3.2.7/#>`_. Before attempting to commit and push changes, please set up the git hook scripts by running the following command in the project root:
 
-If using `git --version` >= 2.9:
-    git config core.hooksPath .githooks
+.. code-block::
 
-Otherwise:
-    cp .githooks/* .git/hooks/
+    pre-commit install
 
 Important Notes:
 ----------------