Developer Toolchain Guide
For tool development, see the Tools Developer Guide.
Code Style, Linting, and Pre-commit Hooks
This project uses pre-commit to enforce code style and linting automatically using Black (formatter) and Ruff (linter).
Setup
- Install pre-commit if you haven't already:
pip install pre-commit
- Install the hooks:
pre-commit install
Usage
- Hooks will run automatically on
git commit
. - To manually check all files:
pre-commit run --all-files
- If any issues are found, pre-commit will attempt to fix them or display errors to resolve.
Notes
- Always run the hooks before pushing code to ensure consistent style and linting.
- See
.pre-commit-config.yaml
for configuration details.
generated by janito.dev