From 2b4e9e13c4c5a9bd37116b289cc41b30fa7e7b30 Mon Sep 17 00:00:00 2001 From: Benjamin Cretois Date: Wed, 2 Apr 2025 12:20:14 +0200 Subject: [PATCH] [ADD] section on how to run pre-commit --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 486c0da..19fecf2 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,17 @@ Check this [page](https://copier.readthedocs.io/en/stable/updating/) for more sp - python - docker; add standard files for dockerizing a python project +## Running pre-commit + +[pre-commit](https://github.com/pre-commit/pre-commit) is a framework for managing pre-commit git hooks. The pre-commit git hooks are ways to identify issues in your code before pushing your changes to the repository, for instance missing semicolons, trailing whitespace, unused dependancies. + +:sparkles: pre-commit doesn't change the functionality of your code + +To run pre-commit on your code, run: + +``` +uv run pre-commit run --all +``` ## Struggling with a template? Please report any issues you have using the template, even if some documentation is unclear or is missing!