From 57fb35b8d76d05475443b823856528bedcbc3425 Mon Sep 17 00:00:00 2001
From: Evan Harvey <eharvey@sandia.gov>
Date: Wed, 20 Mar 2024 08:14:11 -0600
Subject: [PATCH] doc/source: Update contributing

---
 doc/source/contributing.rst | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index d14f455a5..88f59f30b 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -91,8 +91,23 @@ Continuous integration (CI) testing will fail if the changes are not pep8 compli
 
     # Apply correct formatting in CI
     pip install black
-    black /path/to/opencsp
+    black /path/to/opencsp -C -S
 
+
+NOTE, the following pre-commit hook can be added to automatically apply black to your
+commits:
+
+::
+   $ cat .git/hooks/pre-commit
+   for FILE in $(git diff --cached --name-only | egrep '.*\.py$')
+   do
+     if [ -e $FILE ]; then
+       black $FILE -C -S
+       git add $FILE
+     fi
+   done
+   
+   
 Online OpenCSP documentation is generated using Sphinx. For API documentation, we use
 NumPy-style docstrings with bulleted lists. We require NumPy compliant docstrings for 
 Models, Public Classes, and Public Functions. For more internal and development-facing