docs: fix CONTRIBUTING environment setup - #307
Merged
Merged
Conversation
- Environment setup created the venv before cloning the repo, so uv operated in the wrong directory; reorder clone first - pre-commit install ran before pre-commit was installed; the dev extra provides it (uv run pre-commit install) - Drop the standalone pip-tools install (comes via the dev extra) - Fix 'aprstastic' -> 'aprsd' - Add testing instructions (uv run pytest / uv run tox)
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.
Contributor smoke-test of CONTRIBUTING.md found the setup steps could not be followed as written:
uv venv/uv pip install pip-toolsran before the repo clone, so the venv was created in an unrelated directory.pre-commit installran before pre-commit was available (it comes from the project'sdevextra).Fixed by reordering (clone, then
uv venv+uv pip install -e ".[dev]"+uv run pre-commit install), dropping the standalone pip-tools install, and adding testing instructions (uv run pytest tests/uv run tox).Verified:
uv run pytest tests/plugins/test_ping.pypasses with the documented setup.