Merge pull request #260 from arunpersaud/precommit

Precommit
lbl-anp · Apr 16, 2021 · f3c4387 · f3c4387
2 parents 3db9021 + 930f753
commit f3c4387
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,5 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+    - id: black
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,12 +10,17 @@ Please follow these guidelines when contributing to this project.
 pip install -r requirements.txt
 pip install -r requirements-dev.txt
 python setup.py develop
+
+pip install pre-commit
+pre-commit install
 ```
 
 (It is more convenient to use `develop` so that the code is soft-linked
 from the installation directory, and the installed package will always use
 the current version of code.)
 
+We use [`pre-commit`](https://pre-commit.com/) to automatically run black.
+
 ### Running the tests
 
 (Requires `requirements-dev.txt` to be installed)