Description
The current CONTRIBUTING.md is approximately 50 lines and covers only basic setup. It lacks information that would help new contributors be productive.
Proposed Additions
- How to run tests locally —
pytest commands, how to run a single test, how to use pytest-xdist for parallel execution
- How to run linting — Individual
ruff, mypy, pyright, pylint commands (not just build.py lint-and-test)
- Commit message conventions — What style to follow
- PR expectations — What a good PR looks like, expected test coverage
- Architecture orientation — Brief pointer to where different types of changes should go (new platform →
platforms/, new rule type → models.py + driver_base.py, etc.)
- IDE setup tips — Recommended extensions/settings for VS Code or PyCharm given the strict type checking
Description
The current
CONTRIBUTING.mdis approximately 50 lines and covers only basic setup. It lacks information that would help new contributors be productive.Proposed Additions
pytestcommands, how to run a single test, how to usepytest-xdistfor parallel executionruff,mypy,pyright,pylintcommands (not justbuild.py lint-and-test)platforms/, new rule type →models.py+driver_base.py, etc.)