Skip to main content

Appendices

Appendix A: Naming & Style Conventions​

  • Files: kebab-case.tsx for components, *.test.ts in __tests__/
  • Variables: camelCase; Types/Interfaces: PascalCase
  • Commits: Conventional Commits (feat:, fix:, chore:, refactor:, docs:)
  • Env vars: SCREAMING_SNAKE_CASE
  • Packages: @repo/<name> for shared libs

Appendix B: Definition of Done (DoD)​

  • Code compiles; tests + coverage pass
  • Lint + typecheck pass (no warnings)
  • Logs, errors, and traces present where relevant
  • Docs/README updated; flags behind Remote Config if incomplete

Appendix C: Contact & Ownership​

  • Architecture Guild: CODEOWNERS of /docs/adr/
  • Frontend Leads: CODEOWNERS of /apps/web/
  • Backend Leads: CODEOWNERS of /apps/api/
  • Design Systems: CODEOWNERS of /packages/ui/

Final Note: These guardrails optimize for speed and coherence. If you need to diverge, propose an ADR. Prefer automation over policy—if it matters, enforce in code or CI.