From 418d3a545df6a4af65f5e76158538384cf40cb1f Mon Sep 17 00:00:00 2001 From: dharaneesh Date: Wed, 3 Jun 2026 12:44:13 +0530 Subject: [PATCH] docs: surface dev install, lint, typecheck, and test commands in README Signed-off-by: dharaneesh --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d8445238..e3f2121bb 100644 --- a/README.md +++ b/README.md @@ -289,7 +289,13 @@ 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 @@ -297,6 +303,26 @@ If you're contributing to this project, run the initial setup script to install 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: