docs: add CONTRIBUTING.md with dev setup, lint/test commands, and PR conventions#1122
Open
hexcreator wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md with dev setup, lint/test commands, and PR conventions#1122hexcreator wants to merge 1 commit into
hexcreator wants to merge 1 commit into
Conversation
…conventions Consolidates the contributor workflow that previously lived only in CLAUDE.md and pyproject.toml: dev-deps install command, manual lint/format/typecheck/test commands, and the Conventional Commits PR title format. Links it from the README's Development section. Fixes anthropics#966 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #966.
Adds a
CONTRIBUTING.mdat the repo root consolidating the contributor workflow that previously had to be reverse-engineered fromCLAUDE.md,pyproject.toml, and merged PR history:pip install -e ".[dev]"scripts/initial-setup.shruff check/ruff format --check)mypy src/) and test (pytest tests/) commandsAlso links the new file from the README's
## Developmentsection with a two-line quick setup.I went with the standalone
CONTRIBUTING.mdshape (rather than expanding the README) to match the siblinganthropic-sdk-python/anthropic-sdk-typescriptrepos — happy to fold it into the README instead if that's preferred.Verification
Every documented command was run in a fresh Python 3.12 venv against a clean clone:
pip install -e ".[dev]"✓python -m ruff check src/ tests/✓python -m ruff format --check src/ tests/✓python -m mypy src/✓python -m pytest tests/✓ (1056 passed, 5 skipped)🤖 Generated with Claude Code