Summary
The repository currently has no CONTRIBUTING.md file. New contributors
have no single place to learn how to set up the development environment,
run tests, or follow the project's conventions.
What is missing
- How to fork and set up the dev environment using
uv
- How to run tests with
pytest
- How to run pre-commit hooks
- Branch naming conventions (
feat/, fix/, docs/, etc.)
- Commit message style guide
- PR checklist
- Where to get help (Slack, Issues)
Proposed Fix
Add a CONTRIBUTING.md at the repository root covering all of the above.
Why This Matters
- Reduces friction for new contributors and GSoC applicants
- GitHub surfaces
CONTRIBUTING.md automatically when opening a PR
- Aligns with open-source best practices
Summary
The repository currently has no
CONTRIBUTING.mdfile. New contributorshave no single place to learn how to set up the development environment,
run tests, or follow the project's conventions.
What is missing
uvpytestfeat/,fix/,docs/, etc.)Proposed Fix
Add a
CONTRIBUTING.mdat the repository root covering all of the above.Why This Matters
CONTRIBUTING.mdautomatically when opening a PR