Contributors

Canonical onboarding path for developers adding features, fixing bugs, or improving docs.

Need to know

1. Choose a runtime path: Quickstart (Docker) or Local development (Go).
2. Follow the contribution workflow: Contributing guide.
3. Use the supported verification surface:
   • make test during normal implementation
   • make smoke when runtime paths need quick feedback
   • make check before opening or updating a PR
4. If you are changing the web service, read the Web contributor map and run:
   • make web-architecture-check
5. If you are changing the play service, read the Play contributor map and run:
   • make play-architecture-check
   • make play-ui-check for internal/services/play/ui/** changes
6. Use make cover or make cover-critical-domain only when you need focused standalone coverage output separate from make check.
7. Run docs checks for docs-heavy changes:
   • make docs-check
8. Complete PRs with squash only:
   • default to gh pr merge <pr> --auto --squash
   • if auto-merge is unavailable and the PR is mergeable now, use gh pr merge <pr> --squash
   • do not use --merge, --rebase, or --delete-branch

Good to know

• File/package routing: Contributor map
• Play routing and test placement: Play contributor map
• Game service routing and test placement: Game service contributor map
• Extension workflow: Adding a command/event/system
• Play UI component workflow: Play UI Component Storybook Workflow
• Web architecture boundaries: Web architecture
• Web routing and ownership map: Web contributor map
• Web module patterns: Web module playbook

Reference

• Architecture start: Architecture index
• Runtime operations: Running index
• Verification workflow: Verification commands