Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,13 +326,21 @@ code take effect without needing to reinstall.

## Linting

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

– One-time setup (installs the git hook):
```bash
pip install pre-commit
pre-commit install
```

– Run all checks across the repository:
```bash
pre-commit run --all-files
```

Note: You can still run the underlying tools directly via `./lint.sh [fix|check|unsafe]`.

## License

Helion is BSD-style licensed, as found in the LICENSE file.
6 changes: 5 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,14 @@ If you installed with `[dev]`, you get additional development tools:
- **pytest** - Test runner
- **pre-commit** - Code formatting and linting hooks

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

```bash
# Install pre-commit hooks into your local git repo (one-time)
pre-commit install

# Run all checks across the repository
pre-commit run --all-files
```

## Optional Dependencies
Expand Down
Loading