Skip to content

Commit 1f8bf59

Browse files
committed
chore: Add pre-commit hooks configuration
Signed-off-by: Sietze van Buuren <s.van.buuren@gmail.com>
1 parent f7fc3f0 commit 1f8bf59

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

.pre-commit-config.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
default_install_hook_types:
2+
- pre-commit
3+
- commit-msg
4+
5+
repos:
6+
- repo: https://github.com/compilerla/conventional-pre-commit
7+
rev: v4.3.0
8+
hooks:
9+
- id: conventional-pre-commit
10+
stages: [commit-msg]

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ Refer to the [documentation](https://swvanbuuren.github.io/cubinterpp/) for:
4141
- [Mathematical background](https://swvanbuuren.github.io/cubinterpp/theory/)
4242
- [Code reference](https://swvanbuuren.github.io/cubinterpp/reference/)
4343

44+
## Pre-commit hooks
45+
46+
This repository comes with pre-commit hooks. To enable the hooks issue:
47+
48+
```bash
49+
uv run pre-commit install --install-hooks
50+
```
51+
4452
## License
4553

4654
An MIT style license applies for cubinterpp, see the [LICENSE](LICENSE) file for

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ dependencies = [
2727

2828
[dependency-groups]
2929
dev = [
30-
"ruff",
31-
"pytest",
30+
"pre-commit-uv>=4.2.0",
31+
"ruff>=0.7.4",
32+
"pytest>=8.3.3",
3233
]
3334

3435
[project.scripts]

0 commit comments

Comments
 (0)