]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: document pre-commit usage
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Fri, 27 Dec 2024 02:34:00 +0000 (03:34 +0100)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Thu, 9 Jan 2025 13:43:57 +0000 (14:43 +0100)
README.rst

index 68b4458595cfdd01bd266409002fb83ddb54e281..03a2c703bdf70c2cc31b8c12c58482211c17225e 100644 (file)
@@ -84,6 +84,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
 ---------------