Skip to content

fix: update CONTRIBUTING.md dev setup to use uv#63

Merged
Andyyyy64 merged 1 commit into
Andyyyy64:mainfrom
devangpratap:fix/contributing-dev-setup
May 22, 2026
Merged

fix: update CONTRIBUTING.md dev setup to use uv#63
Andyyyy64 merged 1 commit into
Andyyyy64:mainfrom
devangpratap:fix/contributing-dev-setup

Conversation

@devangpratap

Copy link
Copy Markdown
Contributor

Summary

  • CONTRIBUTING.md told contributors to run pip install -e ".[dev]", but pyproject.toml defines dev dependencies under [dependency-groups] (PEP 735), not [project.optional-dependencies]. The pip command fails.
  • Replaced with uv sync --dev and uv run pytest to match the README and the actual build system.

Test plan

  • Verify uv sync --dev installs dev deps correctly
  • Verify uv run pytest runs the test suite

The setup instructions used `pip install -e ".[dev]"` but pyproject.toml
uses `[dependency-groups]` (PEP 735), not `[project.optional-dependencies]`,
so the pip command fails. Align with the README's uv-based workflow.

@Andyyyy64 Andyyyy64 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM!

@Andyyyy64 Andyyyy64 merged commit 546c3df into Andyyyy64:main May 22, 2026
4 checks passed
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.

2 participants