Contribution Guide
Contributions are welcome. Please share your proposal in an Issue first when possible.
Branch policy
Section titled “Branch policy”mainis the release branch- Features and fixes follow the feature branch → PR → merge to main flow
- PRs should include context (what and why) and a test plan
Before opening a PR
Section titled “Before opening a PR”pnpm typecheck # required (CI gate)pnpm lint # Biomepnpm test # testsTests are required in particular for:
- Authentication/authorization changes → regression tests
- API contract changes → update
packages/sharedand verify both API and web sides - DB schema changes → update
apps/api/src/db/schema/database.tsand add an SQL migration in the same change
Commit messages
Section titled “Commit messages”Use Conventional Commits (feat: / fix: / refactor: / docs:, etc.).
Documentation sync
Section titled “Documentation sync”- Stable rules and conventions →
AGENTS.md - Implemented behavior and operational procedures →
docs/ - Remaining work and open decisions →
plan/(do not keep implemented content) - User-facing manual →
apps/docs(this site)
Release flow
Section titled “Release flow”- Pushing a
v*.*.*tag triggers thePublish Releaseworkflow - Images are published to GHCR and a GitHub Release is created
- End users update via
scripts/update.sh - Manual host mutation is never the durable fix — keep changes workflow-based
Security
Section titled “Security”Do not commit secrets. Report vulnerabilities through a security advisory rather than public issues.
See AGENTS.md in the repository for the full development rules.