-
Notifications
You must be signed in to change notification settings - Fork 29
Open
Labels
Description
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 —
pytestcommands, how to run a single test, how to usepytest-xdistfor parallel execution - How to run linting — Individual
ruff,mypy,pyright,pylintcommands (not justbuild.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
Reactions are currently unavailable