docs(readme): document dev setup, local checks, and PR conventions#967
Open
aregmii wants to merge 2 commits into
Open
docs(readme): document dev setup, local checks, and PR conventions#967aregmii wants to merge 2 commits into
aregmii wants to merge 2 commits into
Conversation
Expands the Development section with the dev-deps install (pip install -e ".[dev]"), the manual ruff/mypy/pytest commands documented in CLAUDE.md, and the Conventional Commits PR title convention used by recent merged PRs. Addresses anthropics#966 by consolidating the workflow information where human contributors will find it.
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
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
Closes #966.
Expands the
## Developmentsection so external contributors can find the dev workflow without reverse-engineering it fromCLAUDE.md,pyproject.toml, and merged PR history.Added (addresses every bullet from #966):
pip install -e ".[dev]"for the dev dependencies (pytest,pytest-asyncio,pytest-cov,mypy,ruff)ruff/mypy/pytestcommands that the pre-push hook wrapsAlso kept (the original commit on this branch):
examples/hooks.pyreference now uses a markdown link, matching the format of every other example reference in the READMEDiff (README only, +36 / -3)
And the smaller pre-existing change on the same branch:
Verification
All four documented commands run cleanly on a fresh venv against current
main(Python 3.11.7):Conventional Commits convention verified against the last 8 merged PRs: 7 of 8 follow
<type>(scope): subjector<type>: subject(PRs #956, #955, #933, #932, #931, #927, #924, plus #951 as the one outlier).The PR title format itself follows the convention (
docs(readme): ...).Test plan
Documentation-only change; no source code or behavior modified. The added commands match what
CLAUDE.mddocuments and whatpyproject.toml's[dev]extras group declares. Verification log above shows each command succeeds on a clean checkout.