From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Fri, 27 Dec 2024 02:34:00 +0000 (+0100)
Subject: docs: document pre-commit usage
X-Git-Tag: 3.2.4~7^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=954a637db899b67d148b061b4c7c7186f9b10f46;p=thirdparty%2Fpsycopg.git

docs: document pre-commit usage
---

diff --git a/README.rst b/README.rst
index 68b445859..03a2c703b 100644
--- a/README.rst
+++ b/README.rst
@@ -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
 ---------------