Skip to content

docs: add dev-deps install and test/lint commands to README#1089

Open
Socialpranker wants to merge 1 commit into
anthropics:mainfrom
Socialpranker:docs/dev-setup-readme
Open

docs: add dev-deps install and test/lint commands to README#1089
Socialpranker wants to merge 1 commit into
anthropics:mainfrom
Socialpranker:docs/dev-setup-readme

Conversation

@Socialpranker

Copy link
Copy Markdown

Summary

  • Adds a "Setting Up Your Environment" step (pip install -e ".[dev]") and a "Running Lint, Typecheck, and Tests" section to the README's Development section, right after the existing pre-push hook instructions.
  • The commands mirror what's already documented internally in CLAUDE.md and run in CI, so external contributors don't have to dig for them.

Closes #966

Test plan

  • Rendered the README section locally to confirm formatting/headings are consistent with the rest of the Development section

Closes anthropics#966. The Development section explained the pre-push hook but
not how to install dev dependencies or run the same checks manually.
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