Skip to content

[ADD] section on how to run pre-commit #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frafra merged 1 commit into from
Apr 2, 2025
Merged

[ADD] section on how to run pre-commit #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down