Skip to content

Contributing

import { Aside } from ‘@astrojs/starlight/components’;

Contributions are welcome — bug reports, feature requests, documentation improvements, and pull requests.

RepoContents
play-quibble/triviaGo API, Next.js web frontend
play-quibble/chartsHelm chart
play-quibble/docsThis documentation site

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 release
docs: update README # no release
ci: update workflow # no release

Commits without a conventional prefix are ignored by semantic-release.

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 by sqlc. After any SQL change in queries/ or migrations/, run make sqlc.
  • TypeScript types in src/types/index.ts must be kept in sync manually with apps/api/internal/game/types.go — there is no codegen bridge.
  • IDs are UUIDv7, generated app-side — the DB never generates IDs.
  1. Fork the repo and create a branch from main.
  2. Make your changes with conventional commits.
  3. Open a PR against main.

CI runs lint, tests, and security checks on every PR. All checks must pass before merge.

Do not open a public issue for security vulnerabilities. See SECURITY.md.