From f18c6ae300deb3080e164d16c968e261606720a0 Mon Sep 17 00:00:00 2001
From: Seshan Pillay <30171059+seshxn@users.noreply.github.com>
Date: Wed, 20 May 2026 18:49:01 +0200
Subject: [PATCH] docs: document contributor workflow

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8d8445238..2462a8a2b 100644
--- a/README.md
+++ b/README.md
@@ -289,7 +289,14 @@ 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
@@ -297,6 +304,22 @@ 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`.
 
+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: