From 86c83e75f808ccdde23f523de7d29e340cc075d0 Mon Sep 17 00:00:00 2001
From: Socialpranker <273312799+Socialpranker@users.noreply.github.com>
Date: Wed, 8 Jul 2026 07:03:46 +0200
Subject: [PATCH] docs: add dev-deps install and test/lint commands to README

Closes #966. The Development section explained the pre-push hook but
not how to install dev dependencies or run the same checks manually.
---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 8d8445238..0c99e704a 100644
--- a/README.md
+++ b/README.md
@@ -297,6 +297,33 @@ 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`.
 
+### Setting Up Your Environment
+
+Install the package with its development dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+### Running Lint, Typecheck, and Tests
+
+```bash
+# Lint (auto-fix) and format
+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/
+
+# Run a specific test file
+python -m pytest tests/test_client.py
+```
+
+These are the same checks the CI workflow and pre-push hook run.
+
 ### Building Wheels Locally
 
 To build wheels with the bundled Claude Code CLI: