docs: add CONTRIBUTING.md with dev setup, lint, test, and PR guidelines#998
Open
2023Anita wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md with dev setup, lint, test, and PR guidelines#9982023Anita wants to merge 1 commit into
2023Anita wants to merge 1 commit into
Conversation
Surface dev-dependency install command, manual lint/typecheck/test commands, and PR title conventions. Previously this information was scattered across CLAUDE.md (agent-facing), pyproject.toml, and merged PR history. Closes 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.
Summary
Add
CONTRIBUTING.mdat repo root and link it from README's Development section. Surfaces dev-dependency install, manual lint/typecheck/test commands, and PR title conventions.Motivation
Currently, external contributors must:
pyproject.tomlto discover thedevextras groupCLAUDE.md(agent-facing) to find lint/test commandsCONTRIBUTING.mdconsolidates all of this in one place a human contributor naturally looks.Verification
python -m ruff check CONTRIBUTING.md— not applicable (Markdown)Risk / Compatibility
Zero risk. Documentation-only change. No code, config, or behavior changes.
Related
Closes #966