From 80fb24b7c557295ba32e9b9b1a9a783b10100780 Mon Sep 17 00:00:00 2001 From: Marco D'Aleo Date: Sat, 15 Nov 2025 08:04:30 +0000 Subject: [PATCH] Add pre-commit section to README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 534cd1b..1cd4f3f 100644 --- a/README.md +++ b/README.md @@ -86,3 +86,13 @@ resrm --empty Normal users: `~/.local/share/resrm/files` Root user: `/root/.local/share/resrm/files` + +## pre-commit +This project uses [**pre-commit**](https://pre-commit.com/) to run automatic formatting and security checks before each commit (Black, Bandit, and various safety checks). + +To enable it: +``` +poetry install +poetry run pre-commit install +``` +This ensures consistent formatting, catches common issues early, and keeps the codebase clean.