Skip to content

docs: add CONTRIBUTING.md with dev setup and PR workflow#1005

Open
Oxygen56 wants to merge 1 commit into
anthropics:mainfrom
Oxygen56:docs/add-contributing
Open

docs: add CONTRIBUTING.md with dev setup and PR workflow#1005
Oxygen56 wants to merge 1 commit into
anthropics:mainfrom
Oxygen56:docs/add-contributing

Conversation

@Oxygen56
Copy link
Copy Markdown

Closes #966

Adds a CONTRIBUTING.md to the repo root that documents the developer setup and pull request workflow. The information was previously scattered across CLAUDE.md and pyproject.toml.

Contents:

  • Development environment setup (pip install -e ".[dev]")
  • Lint and format commands (ruff, mypy)
  • Testing commands (pytest)
  • Pull request guidelines including Conventional Commits PR title convention
  • Contributor License Agreement requirement

alexbevi added a commit to alexbevi/claude-agent-sdk-python that referenced this pull request Jun 2, 2026
Anticipates the contributing guide proposed in PR anthropics#1005 by:

- Running ruff format on the adapter module and test file (previously
  passed `ruff check` but not `ruff format --check`).
- Fixing two ruff B023 findings in the concurrency test, where inner
  closures captured the loop's `key` variable. Bound via default arg
  so each iteration gets its own value — same fix the linter
  recommends, prevents a real future bug if the loop body grows.

After this change the package now passes the full set of checks the
guide enumerates: `ruff check src/ tests/`, `ruff format --check src/
tests/`, and `mypy src/`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Surface dev-deps install + test/lint commands in README (or add CONTRIBUTING.md)

1 participant