Contributing
import { Aside } from ‘@astrojs/starlight/components’;
Contributions are welcome — bug reports, feature requests, documentation improvements, and pull requests.
Repositories
Section titled “Repositories”| Repo | Contents |
|---|---|
| play-quibble/trivia | Go API, Next.js web frontend |
| play-quibble/charts | Helm chart |
| play-quibble/docs | This documentation site |
Commit format
Section titled “Commit format”This repo uses Conventional Commits — required for semantic-release to version correctly.
feat: add question timer UI # minor bump (1.x.0)fix: correct score calculation # patch bump (1.0.x)feat!: redesign game state machine # major bump (x.0.0)chore: update deps # no releasedocs: update README # no releaseci: update workflow # no releaseCommits without a conventional prefix are ignored by semantic-release.
Development setup
Section titled “Development setup”See Quick Start for local development setup.
Key things to know before contributing:
- Never edit
apps/api/internal/store/by hand — it is fully generated bysqlc. After any SQL change inqueries/ormigrations/, runmake sqlc. - TypeScript types in
src/types/index.tsmust be kept in sync manually withapps/api/internal/game/types.go— there is no codegen bridge. - IDs are UUIDv7, generated app-side — the DB never generates IDs.
Pull requests
Section titled “Pull requests”- Fork the repo and create a branch from
main. - Make your changes with conventional commits.
- Open a PR against
main.
CI runs lint, tests, and security checks on every PR. All checks must pass before merge.
Reporting security issues
Section titled “Reporting security issues”Do not open a public issue for security vulnerabilities. See SECURITY.md.