link,[object Object]
Skip to content

Contributing Conventions ​

Purpose: Provide repo conventions for smooth collaboration. Audience: Developer, AI Agent Prerequisites: Git access.

Branches

  • Features: feat/<area>-<slug> (e.g., feat/db-deals-mvp).
  • Fixes: fix/<area>-<slug>.
  • Docs: docs/<topic>.

Commits

  • feat(deals): implement payout release
  • chore(db): add index on subscriptions
  • fix(admin): correct table sorting
  • docs(docs): unify guides

PR checklist

  • What/why, files touched, acceptance criteria, manual test steps.
  • Link related issues/cards.

Code style

  • TypeScript, React 18, Tailwind + shadcn/ui.
  • Avoid secrets in code; use env per docs/setup/environment.md.

Adding a feature (E2E)

  • Create route (see docs/architecture/routing.md).
  • Add data model/migration if needed (see docs/setup/supabase.md).
  • Implement UI with shadcn primitives.
  • Add caching and invalidation (see docs/architecture/state-management.md).
  • Write tests (see docs/testing/strategy.md).

Next steps

  • See docs/audiences/ai-agent.md for automation rules.