Skip to content

Commit 7dfc066

Browse files
committed
docs: document pre-commit usage
1 parent 137b51f commit 7dfc066

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.rst

+9
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,15 @@ Now hack away! You can run the tests using::
8383
export PSYCOPG_TEST_DSN="dbname=psycopg_test"
8484
pytest
8585

86+
The library includes some pre-commit hooks to check that the code is valid
87+
according to the project coding convention. Please make sure to install them
88+
by running::
89+
90+
pre-commit install
91+
92+
This will allow to check lint errors before submitting merge requests, which
93+
will save you time and frustrations.
94+
8695

8796
Cross-compiling
8897
---------------

0 commit comments

Comments
 (0)