Contributing

Documentation Index

Fetch the complete documentation index at: https://docs.yourhq.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Layer model

ui/        ← primitives. shadcn + a few HQ extensions. No business logic.
shared/    ← composites. Reused across two or more feature modules.
<module>/  ← features. CRM, tasks, agents, knowledge, collections, routines.

• apps/ui/src/components/ui/ — generic, reusable UI building blocks. Imports: React, Radix, cn from @/lib/utils, other primitives. Never imports from shared/ or feature modules.
• apps/ui/src/components/shared/ — HQ-specific compositions used across modules. Imports: primitives, other composites, lib/utils, generic types from lib/. Never imports from a specific feature module.
• apps/ui/src/components/<module>/ — feature-specific. Imports: anything inner. Free to import from its own lib/<module>/ and hooks/use-<module>.ts.

​

Module convention

​

File and identifier naming

• Files — kebab-case. contact-detail-view.tsx, not ContactDetailView.tsx. Includes hooks (use-contacts.ts) and helpers (format-money.ts).
• Components — PascalCase exports. export function ContactDetailView().
• Hooks — use prefix, camelCase identifier, kebab-case filename.
• Types — PascalCase. Schema-mirrored types match the table singularized: Contact, Task, Stream, Agent.
• Server actions — <verb><Noun>Action. archiveContactAction, createTaskAction. They live in app/dashboard/<module>/actions.ts and start with "use server".
• CSS classnames — none. We don’t write classnames; we use Tailwind utilities and tokens.

​

Imports

​

Styling rules

• Tokens, not hexes. Use Tailwind utilities mapped from globals.css. If a value isn’t covered by a token, the right move is almost always to use the next step on the existing scale, not to inline a custom value.
• cn() for conditional classes. Imported from @/lib/utils. Use it whenever class strings depend on props or state.
• CVA for variants. Components with two or more visual variants use class-variance-authority. Reference: button.tsx, badge.tsx.
• data-slot attributes on composed primitives. Lets parents target sub-parts via [data-slot=…] selectors without prop drilling.
• No CSS Modules, no styled-components, no Emotion. Tailwind plus the editor styles in globals.css are the only style surfaces.

​

Decision tree: where does this code go?

​

1. Is it a primitive (no business logic, no module imports)?

• It must be reusable in any context, not just HQ.
• It must not import from shared/ or any feature module.
• It must not depend on any HQ-specific data shape.

​

2. Is it a composite (HQ-shaped, used across modules)?

1. It’s used in two or more modules already. If you’re about to copy something from crm/ into tasks/, that’s the threshold. Lift it before the second copy.
2. The API is stable. Composites encode shape decisions. If you’re not sure of the props yet, leave it inside the feature for one more iteration before promoting.
3. It depends only on ui/, other shared/, lib/utils, and React. Composites must not import from feature modules. If yours needs a feature hook, pass the data in as props.

​

3. Is it feature-specific?

​

Adding a new feature module

1. Database — add the migration under db/migrations/0NN_widgets.sql. Include tenant_id, RLS policies, explicit GRANT for authenticated and service_role. Run in filename order.
2. Types — apps/ui/src/lib/widgets/types.ts. Mirror the table.
3. Hook — apps/ui/src/hooks/use-widgets.ts. Subscribes via use-realtime-sync, owns filters/sorting/selection state, exposes actions.
4. Server actions — apps/ui/src/app/dashboard/widgets/actions.ts. "use server". Each action returns { data, error } or throws.
5. Routes — app/dashboard/widgets/page.tsx, app/dashboard/widgets/[id]/page.tsx, app/dashboard/widgets/error.tsx.
6. Components — components/widgets/widgets-tab.tsx (orchestrator), widgets-table-view.tsx, widget-detail-view.tsx, widget-form.tsx. Open with a PageHeader. List uses DataTable inside a FilterBar. Detail uses DetailHeader plus DetailSidebar. Create uses SidePanel if widgets are record-style (the user manages them from a list), or Dialog if widgets are capture-style (the user creates them from anywhere) — see creation and editing.
7. Shell registration — add the module to:
   • The sidebar in components/dashboard-shell.tsx.
   • The navigation list in components/shared/command-palette.tsx.
   • The G-shortcut table in components/shared/keyboard-shortcuts.tsx.
   • The workspace’s enabled-modules list (so ModulesContext can gate it).

​

When to add a token

• “We need a color for the ‘snoozed’ task state” → add --status-snoozed to :root and .dark, wire through @theme inline.
• “We need a slightly darker red for this one button” → don’t add a token. Use bg-destructive/90 or pick a color closer to an existing token.

​

When NOT to add a primitive

• “A list item with a checkbox and a status dot.” → composite (Item exists; compose).
• “A button that opens a confirm dialog.” → composite (use ConfirmDialog).
• “An input that shows the user’s avatar inside it.” → feature (specific to one form).
• “A reusable card for showing an agent.” → feature inside components/agents/.

​

Code review checklist

• No inline hex codes, no #fff, no rgb(). Tokens via Tailwind utilities.
• Aliases for cross-directory imports.
• No imports from app/ or feature modules into ui/ or shared/.
• cn() from @/lib/utils for conditional classes (not template literals).
• CVA for any component with two-plus visual variants.
• Components are kebab-case files, PascalCase exports.
• Hooks subscribe and unsubscribe correctly (cleanup in the useEffect return).
• Lists use DataTable (not bare Table); creates use SidePanel for record editing or Dialog for quick capture — never bare Sheet or Dialog primitives directly.
• Empty states are present on every list. Loading skeletons match the layout.
• No comments narrating what the code does. Only comments where the why is non-obvious.
• npx tsc --noEmit passes from apps/ui/.
• npm run lint passes.