From 7dfc06668d476e929145b6cfb9e63d392be5e149 Mon Sep 17 00:00:00 2001 From: Daniele Varrazzo Date: Fri, 27 Dec 2024 03:34:00 +0100 Subject: [PATCH] docs: document pre-commit usage --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index b29e83952..575e1731e 100644 --- a/README.rst +++ b/README.rst @@ -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 --------------- -- 2.39.5