docs(readme): expand Development section with dev-deps, manual checks, PR conventions#1000
Open
coding-shalabh wants to merge 1 commit into
Open
docs(readme): expand Development section with dev-deps, manual checks, PR conventions#1000coding-shalabh wants to merge 1 commit into
coding-shalabh wants to merge 1 commit into
Conversation
…, PR conventions The README's Development section previously documented only the initial git-hook setup. The dev-dependency install command, the manual lint / typecheck / test commands, and the PR title convention all existed in the repo (pyproject.toml dev extras, CLAUDE.md, merged PR history) but external contributors had to reverse-engineer them from those sources. This consolidates the existing information under three new subsections: - Setting up — pip install -e ".[dev]" + a pointer to the dev extras - Running checks manually — the four ruff/mypy/pytest commands from CLAUDE.md, plus a single-test-file invocation - Pull request conventions — Conventional Commits prefix in PR titles, scoping, and the expectation that behavior changes get tests No commands are introduced that aren't already used somewhere in the repo. The existing Git hooks, Building Wheels Locally, and Release Workflow subsections are unchanged. Fixes anthropics#966
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.
Fixes #966.
What this PR does
Expands the README's
## Developmentsection to surface information that already exists across the repo but isn't where contributors naturally look.Three new subsections under Development:
Setting up
Adds the
pip install -e \".[dev]\"install command and points at where the dev extras are declared (pyproject.toml→[project.optional-dependencies]).Running checks manually
Documents the four commands from
CLAUDE.md— ruff check, ruff format, mypy, pytest — plus a single-test-file invocation. Notes that the pre-push hook covers ruff only, so mypy and pytest need to be run manually before opening a PR.Pull request conventions
Calls out the Conventional Commits prefix that's used consistently across merged PRs (
feat:/fix:/docs:/chore:/refactor:/test:etc.), plus PR-scoping and test-update expectations.The existing Git hooks, Building Wheels Locally, and Release Workflow subsections are unchanged. Diff is +50 / -2.
Things I deliberately did not do
CONTRIBUTING.md. The issue offered both options; README expansion is the lower-friction shape and easy to extract intoCONTRIBUTING.mdlater if you'd prefer that for GitHub's auto-banner on issue/PR pages. Happy to follow up with a smallCONTRIBUTING.mdthat links here if you'd like.CLAUDE.md,scripts/, orpyproject.toml. Nothing fabricated.Verification
Rendered the new README locally to confirm the markdown structure is correct. No code changes, so no test impact.