Skip to content

docs: surface dev install, lint, typecheck, and test commands in README#1020

Open
dharaneeshexe-web wants to merge 1 commit into
anthropics:mainfrom
dharaneeshexe-web:docs/add-contributing-setup-commands
Open

docs: surface dev install, lint, typecheck, and test commands in README#1020
dharaneeshexe-web wants to merge 1 commit into
anthropics:mainfrom
dharaneeshexe-web:docs/add-contributing-setup-commands

Conversation

@dharaneeshexe-web
Copy link
Copy Markdown

What this PR does / why we need it:
Closes #966

Adds the following to the ## Development section in README.md:

  • Dev dependency install command (pip install -e ".[dev]")
  • Manual lint, typecheck, and test commands surfaced from CLAUDE.md
  • Pull request guidelines (Conventional Commits title format)

Special notes for your reviewers:

  • The information already existed in CLAUDE.md and pyproject.toml but was not discoverable by human contributors.
  • No code changes, documentation only.

Signed-off-by: dharaneesh <dharaneeshexe@gmail.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