Skip to content

Commit 69d966f

Browse files
authored
[Docs] Consistent pre-commit/lint (#836)
1 parent 4ffac30 commit 69d966f

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,13 +326,21 @@ code take effect without needing to reinstall.
326326

327327
## Linting
328328

329-
To run linting checks:
329+
We use `pre-commit` to run ruff, pyright, and other checks automatically.
330330

331+
– One-time setup (installs the git hook):
331332
```bash
332333
pip install pre-commit
334+
pre-commit install
335+
```
336+
337+
– Run all checks across the repository:
338+
```bash
333339
pre-commit run --all-files
334340
```
335341

342+
Note: You can still run the underlying tools directly via `./lint.sh [fix|check|unsafe]`.
343+
336344
## License
337345

338346
Helion is BSD-style licensed, as found in the LICENSE file.

docs/installation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,14 @@ If you installed with `[dev]`, you get additional development tools:
126126
- **pytest** - Test runner
127127
- **pre-commit** - Code formatting and linting hooks
128128

129-
Set up pre-commit hooks for development:
129+
Set up and use pre-commit for linting:
130130

131131
```bash
132+
# Install pre-commit hooks into your local git repo (one-time)
132133
pre-commit install
134+
135+
# Run all checks across the repository
136+
pre-commit run --all-files
133137
```
134138

135139
## Optional Dependencies

0 commit comments

Comments
 (0)