Skip to content

[None][docs] use requirements-dev.txt for dev environment setup in CONTRIBUTING.md#14490

Open
fuergaosi233 wants to merge 1 commit into
NVIDIA:mainfrom
fuergaosi233:fix/contributing-mypy-version
Open

[None][docs] use requirements-dev.txt for dev environment setup in CONTRIBUTING.md#14490
fuergaosi233 wants to merge 1 commit into
NVIDIA:mainfrom
fuergaosi233:fix/contributing-mypy-version

Conversation

@fuergaosi233
Copy link
Copy Markdown

@fuergaosi233 fuergaosi233 commented May 23, 2026

Summary

  • CONTRIBUTING.md instructed contributors to run pip install pre-commit mypy without a version pin
  • requirements-dev.txt pins mypy==1.19.1 along with other required dev tools (typeguard, ruff, bandit, etc.)
  • Using an unpinned mypy install could result in a different mypy version than CI uses, causing type check failures that are hard to reproduce locally

Changes

Replace the ad-hoc install command with pip install -r requirements-dev.txt to ensure contributors use the same tool versions as CI.

Test plan

  • Verify pip install -r requirements-dev.txt && pre-commit install sets up a working dev environment
  • Verify mypy --version reports 1.19.1 after installation

Summary by CodeRabbit

  • Documentation
    • Updated local development setup instructions to install development dependencies via a requirements file instead of individual package installation.

Review Change Stack

…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>
@fuergaosi233 fuergaosi233 requested a review from a team as a code owner May 23, 2026 19:23
@fuergaosi233 fuergaosi233 requested review from QiJune and kaiyux May 23, 2026 19:23
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 4db3fc27-4f0b-4ac0-a2c3-c720fddf2733

📥 Commits

Reviewing files that changed from the base of the PR and between c5b0372 and e8fb6a0.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

CONTRIBUTING.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.

Changes

Development Setup Documentation

Layer / File(s) Summary
Pre-commit setup instructions
CONTRIBUTING.md
The local setup section for pre-commit is updated to use pip install -r requirements-dev.txt instead of pip install pre-commit mypy, centralizing development dependency installation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: updating CONTRIBUTING.md to use requirements-dev.txt for development environment setup instead of ad-hoc pip installs.
Description check ✅ Passed The PR description adequately explains the issue (unpinned mypy versions causing CI mismatches), the solution (using requirements-dev.txt), and includes a test plan, though it deviates from the template structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant