You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: note virtual environment requirement for pre-commit hooks (#745)
Some hooks require tools from dev dependency groups to be on PATH.
Add note to installation steps and common issues table directing
contributors to activate the virtual environment before committing.
Relates to #744.
Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,10 @@ to melleaadmin@ibm.com.
71
71
```bash
72
72
pre-commit install
73
73
```
74
+
> **Note:** Some hooks require tools in dev dependency groups to be on your PATH. Activate the virtual environment before committing to ensure they are available:
75
+
> ```bash
76
+
>source .venv/bin/activate
77
+
>```
74
78
75
79
### Installation with `conda`/`mamba`
76
80
@@ -430,7 +434,7 @@ CICD=1 uv run pytest
430
434
| Output is wrong/None | Model too small or needs better prompt. Try larger model or add `reasoning` field. |
431
435
|`error: can't find Rust compiler`| Python 3.13+ requires Rust for outlines. Install [Rust](https://www.rust-lang.org/tools/install) or use Python 3.12. |
432
436
| Tests fail on Intel Mac | Use conda: `conda install 'torchvision>=0.22.0'` then `uv pip install mellea`. |
433
-
| Pre-commit hooks fail | Run `pre-commit run --all-files` to see specific issues. Fix or use `git commit -n` to bypass. |
437
+
| Pre-commit hooks fail | Run `pre-commit run --all-files` to see specific issues. Fix or use `git commit -n` to bypass. If a tool reports `command not found`, activate the virtual environment before committing: `source .venv/bin/activate`. |
0 commit comments