From 9278e52fc74faa837e2d187ec47edc725f36dbff Mon Sep 17 00:00:00 2001 From: David Kilias Date: Sun, 4 Feb 2024 21:28:52 +0100 Subject: [PATCH] doc: add pre-commit info to readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index b98e538..4f41fd0 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,25 @@ Dieses Repository nutzt zur Verwaltung von großen Binärdaten (Bilder und PDFs) Die Arbeit mit den Dateien ändert sich durch die Verwendung von git-lfs nicht. +## pre-commit + +Dieses Reoisitory nutzt [pre-commit](https://pre-commit.com/), um git pre-commit-hooks auszuführen. + +### [Installation](https://pre-commit.com/#installation) + +```bash +# install package +pip install pre-commit +# install pre-commit-hooks in repo +pre-commit install +# run (new) hooks against all files in repo +pre-commit run --all-files +``` + +### Genutzte hooks + +Siehe [.pre-commit-config.yaml](./.pre-commit-config.yaml) + ## License © Netz39 e.V