Skip to content

Commit 2e417cc

Browse files
authored
[ADD] section on how to run pre-commit (#35)
1 parent 2adfd7e commit 2e417cc

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,17 @@ Check this [page](https://copier.readthedocs.io/en/stable/updating/) for more sp
4545
- python
4646
- docker; add standard files for dockerizing a python project
4747

48+
## Running pre-commit
49+
50+
[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.
51+
52+
:sparkles: pre-commit doesn't change the functionality of your code
53+
54+
To run pre-commit on your code, run:
55+
56+
```
57+
uv run pre-commit run --all
58+
```
4859

4960
## Struggling with a template?
5061
Please report any issues you have using the template, even if some documentation is unclear or is missing!

0 commit comments

Comments
 (0)