Skip to content
Open
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
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,14 +289,40 @@ If you're upgrading from the Claude Code SDK (versions < 0.1.0), please see the

## Development

If you're contributing to this project, run the initial setup script to install git hooks:
If you're contributing to this project, first install the dev dependencies:

```bash
pip install -e ".[dev]"
```

Then run the initial setup script to install git hooks:

```bash
./scripts/initial-setup.sh
```

This installs a pre-push hook that runs lint checks before pushing, matching the CI workflow. To skip the hook temporarily, use `git push --no-verify`.

### Lint, Typecheck & Test

```bash
# Lint and auto-fix
python -m ruff check src/ tests/ --fix
python -m ruff format src/ tests/

# Typecheck
python -m mypy src/

# Run all tests
python -m pytest tests/
```

### Pull Request Guidelines

- Use [Conventional Commits](https://www.conventionalcommits.org/) for PR titles (e.g., `feat: ...`, `fix: ...`, `docs: ...`, `chore: ...`).
- Keep PRs focused on a single change.
- Ensure all lint, typecheck, and test steps pass before requesting review.

### Building Wheels Locally

To build wheels with the bundled Claude Code CLI:
Expand Down