Skip to content

Commit 1cf9c92

Browse files
committed
Add documentation regarding pre commit hooks
1 parent b313e34 commit 1cf9c92

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

doc/user_guide/getting_started.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,21 @@ forward and you just can use the example *noxfile.py* bellow.
6666
.. literalinclude:: ../../noxfile.py
6767
:language: python3
6868

69+
6. Setup the pre-commit hooks
70+
+++++++++++++++++++++++++++++
6971

70-
6. Go 🥜
72+
#. Add the following .pre-commit-config.yaml to your project root
73+
74+
.. literalinclude:: ../../.pre-commit-config.yaml
75+
:language: yaml
76+
77+
#. Enable pre commit hooks for your workspace
78+
79+
.. code-block:: shell
80+
81+
poetry run pre-commit install
82+
83+
7. Go 🥜
7184
+++++++++++++
7285
You are ready to use the toolbox. With *nox -l* you can list all available tasks.
7386

@@ -91,4 +104,3 @@ You are ready to use the toolbox. With *nox -l* you can list all available tasks
91104
92105
93106
Enjoy!
94-

0 commit comments

Comments
 (0)