docs: updates code guidelines documentation

rickstaa · Sep 9, 2021 · 4f96a46 · 4f96a46
1 parent 80a59c4
commit 4f96a46
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/contributing.md b/contributing.md
@@ -19,7 +19,7 @@ Projects that are open for contributions can be found on the [issue tab](https:
 
 ## Commit instructions
 
-We use husky pre-commit hooks to ensure code quality. As a result you have to perform the following steps before you can commit any changes:
+We use husky pre-commit hooks to ensure code quality. To enable these hooks please:
 
 1.  Install [node](https://nodejs.org/en/download/package-manager/).
 2.  Install [python](https://www.python.org/downloads/).

diff --git a/docs/source/dev/release_dev.rst b/docs/source/dev/release_dev.rst
@@ -32,6 +32,18 @@ Markdown guidelines:
 
 .. _`Github Actions`: https://github.com/rickstaa/bayesian-learning-control/actions
 
+
+Pre-commit hooks
+----------------
+
+The BLC package also contains several pre-commit hooks that can be used to enforce the aforementioned guidelines before a commit is made. To enable these hooks please:
+
+1.  Install `node <https://nodejs.org/en/download/package-manager>`_.
+2.  Install `python <https://www.python.org/downloads>`_.
+3.  Run ``npm install -D`` and ``pip install .[dev]`` to install husky and the required linters.
+4.  Run ``npm run prepare`` to setup the pre-commit hooks.
+
+
 General guidelines
 ==================