]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: document pre-commit usage 980/head
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Fri, 27 Dec 2024 02:34:00 +0000 (03:34 +0100)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Fri, 27 Dec 2024 03:42:00 +0000 (04:42 +0100)
README.rst

index b29e83952e2938311f600d7e1f128b2188d066bb..575e1731e257b9d937761db97316e41742ad0b78 100644 (file)
@@ -83,6 +83,15 @@ Now hack away! You can run the tests using::
     export PSYCOPG_TEST_DSN="dbname=psycopg_test"
     pytest
 
+The library includes some pre-commit hooks to check that the code is valid
+according to the project coding convention. Please make sure to install them
+by running::
+
+    pre-commit install
+
+This will allow to check lint errors before submitting merge requests, which
+will save you time and frustrations.
+
 
 Cross-compiling
 ---------------