Contributing¶
Everyone is welcome. You don't need to write code: players, organizers, platform builders, and statisticians can all help. Start with the organization contributing guide, which applies to every repository. A repository's own guide adds to it.
Rules for every repository¶
- Open an issue before starting anything large, in the repository it is about.
- Keep each pull request to one change, linked to its issue.
- Sign off every commit under the Developer Certificate of Origin:
git commit -s. A check rejects pull requests with unsigned commits. - Never put real player data in code, tests, issues, pull requests, or screenshots. Use made-up names and codes.
- Report security problems privately, as the security policy describes.
- Everyone agrees to the mission charter and the Code of Conduct.
Backend¶
openpickleball/backend: read its contributing guide and README. You need uv and Docker. The quick start runs Postgres and Valkey with docker compose up -d --wait, then uv run pytest. Check the architecture decision records and CONTEXT.md before changing a decision or naming a model.
Engine¶
openpickleball/engine: read its README. It has no guide of its own, so the organization guide applies. Install it from a checkout with pip install -e ".[dev]", then run pytest, ruff check ., and mypy src.
Frontend¶
openpickleball/frontend: read its contributing guide and README. It uses Node 26 and pnpm. site/ and app/ are separate projects: run pnpm install and pnpm dev in the one you change.
Rating spec¶
openpickleball/rating-spec: anyone can propose or challenge a change by opening an issue with the rating spec change form in the .github repository, with evidence. A change that gets support becomes an RFC under the RFC process. The governing board makes the final decision.
This site¶
openpickleball/developers: read its contributing guide. Preview it with uv run mkdocs serve.
Organization files¶
openpickleball/.github holds the charter, governance, roadmap, licensing policy, and the organization guide.