Skip to content

docs: document contributor workflow #978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
seshxn wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: document contributor workflow #978

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,14 +289,37 @@ 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, install the package with development
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`.

You can also run the checks manually:

```bash
# Check for issues and fix automatically
python -m ruff check src/ tests/ --fix
python -m ruff format src/ tests/

# Typecheck
python -m mypy src/

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

Please use [Conventional Commits](https://www.conventionalcommits.org/) for PR titles, for example `fix: handle subprocess errors`.

### Building Wheels Locally

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