28 lines
696 B
Markdown
28 lines
696 B
Markdown
## Pre-commit Hooks
|
|
|
|
This project uses [pre-commit](https://pre-commit.com/) to ensure code quality and consistent formatting for all contributors.
|
|
|
|
### First-time setup
|
|
|
|
1. Run the setup script (recommended):
|
|
```bash
|
|
./setup.sh
|
|
```
|
|
This will install pre-commit (if not already installed) and set up the git hooks for you.
|
|
|
|
2. Or, manually install pre-commit and the hooks:
|
|
```bash
|
|
pip install pre-commit
|
|
pre-commit install
|
|
```
|
|
|
|
### Running hooks manually
|
|
|
|
To check all files with pre-commit hooks:
|
|
```bash
|
|
pre-commit run --all-files
|
|
```
|
|
|
|
### CI Enforcement
|
|
|
|
All commits and pull requests are checked with pre-commit hooks in CI. You must pass these checks to merge code. |