Skip to content

Commit 49b03c0

Browse files
authored
Add Pre-Commit Configuration Instructions to README File (#2306)
1 parent eb467b7 commit 49b03c0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.rst

+14
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,20 @@ Installation
3131

3232
pip install -r requirements.txt
3333

34+
Auto-formatting with pre-commit
35+
-------------------------------
36+
37+
This project uses `pre-commit <https://pre-commit.com/>`_.
38+
39+
#. Install test dependencies, if not already installed::
40+
41+
pip install -r requirements-test.txt
42+
43+
#. Set up the git pre-commit hooks in your clone::
44+
45+
pre-commit install
46+
47+
Every time you try to commit, pre-commit checks your files to ensure they follow our style standards and aren't affected by some simple issues. If the checks fail, pre-commit won't let you commit.
3448

3549
Running the Bot Rules
3650
---------------------

0 commit comments

Comments
 (0)