Brohammad / Brohammad/VoxForge
Add a pre-commit hook for ruff check + format
- Dominant language
- Python
- Stars
- 4
- Forks
- 1
- Avg merge
- 5d 13m
- Merged PRs (30d)
- 10
Description
## Task
CI runs `ruff check` and `ruff format --check`, but there is no `.pre-commit-config.yaml`. Easy way to fail locally before push.
## Scope
- Add `.pre-commit-config.yaml` with ruff (check + format)
- Document `pre-commit install` in CONTRIBUTING.md
- Pin a current ruff rev compatible with `pyproject.toml`
## Acceptance criteria
- [ ] Hook is optional (do not make it mandatory in CI beyond existing ruff jobs)
- [ ] CONTRIBUTING mentions it
- [ ] `ruff check src tests` still matches CI
Contributor guide
Research direction
Start by comparing the existing CI ruff commands with pyproject.toml, then inspect CONTRIBUTING.md. Add the optional .pre-commit-config.yaml with a pinned compatible ruff revision and document pre-commit install; done means the documentation is present and ruff check src tests still matches CI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 84/100