Skip to content

Commit 2e28e0c

Browse files
author
Ivan Ivanou
committed
Added pre-commit instructions
1 parent b94bdf1 commit 2e28e0c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,18 @@ Here is a simple overview below:
7373
If you need some help with Git, follow this quick start
7474
guide: https://git.wiki.kernel.org/index.php/QuickStart
7575

76+
#. Install `pre-commit <https://pre-commit.com>`_ and its hook on the client-Python repo:
77+
78+
**Note: pre-commit must be installed as admin, as it will not function otherwise**::
79+
80+
$ pip install --user pre-commit
81+
$ pre-commit install
82+
83+
Afterwards ``pre-commit`` will run whenever you commit.
84+
85+
https://pre-commit.com/ is a framework for managing and maintaining multi-language pre-commit hooks
86+
to ensure code-style and code formatting is consistent.
87+
7688
#. Install tox
7789

7890
Tox is used to run all the tests and will automatically setup virtualenvs

0 commit comments

Comments
 (0)