[None][docs] use requirements-dev.txt for dev environment setup in CONTRIBUTING.md#14490
Open
fuergaosi233 wants to merge 1 commit into
Open
[None][docs] use requirements-dev.txt for dev environment setup in CONTRIBUTING.md#14490fuergaosi233 wants to merge 1 commit into
fuergaosi233 wants to merge 1 commit into
Conversation
…NTRIBUTING.md The CONTRIBUTING.md setup instructions used `pip install pre-commit mypy` without a version pin, which could install a version of mypy incompatible with CI checks. requirements-dev.txt already pins mypy==1.19.1 along with other required dev tools (typeguard, ruff, bandit, etc.). Replace the ad-hoc install command with `pip install -r requirements-dev.txt` to ensure contributors use the same tool versions as CI. Signed-off-by: holegots <fuergaosi@gmail.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughCONTRIBUTING.md is updated to streamline the local development setup instructions. The pre-commit installation step now references the requirements-dev.txt file instead of individually specifying pre-commit and mypy packages, consolidating dependency management into a single file. ChangesDevelopment Setup Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
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
CONTRIBUTING.mdinstructed contributors to runpip install pre-commit mypywithout a version pinrequirements-dev.txtpinsmypy==1.19.1along with other required dev tools (typeguard, ruff, bandit, etc.)mypyinstall could result in a different mypy version than CI uses, causing type check failures that are hard to reproduce locallyChanges
Replace the ad-hoc install command with
pip install -r requirements-dev.txtto ensure contributors use the same tool versions as CI.Test plan
pip install -r requirements-dev.txt && pre-commit installsets up a working dev environmentmypy --versionreports1.19.1after installationSummary by CodeRabbit