mirror of https://github.com/supabase/supabase.git synced 2026-05-06 08:56:46 -04:00

Files

T

Danny White 19db989938 chore: improve AGENTS instructions (#45030 )

## What kind of change does this PR introduce?

AGENTS.md update.

## What is the current behavior?

None of the below are specified in AGENTS.md.

## What is the new behavior?

- Specify U.S. English in code. This is necessary as many of us use
British English or equivalent, and this can creep into code

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Chores**
* Added/updated contribution documentation to specify that all
repository text should use U.S. English for consistency.

---

**Note:** This change updates internal documentation conventions only
and does not affect end-user functionality.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2026-04-24 15:04:11 +10:00

1.7 KiB

Raw Permalink Blame History

Supabase Monorepo

pnpm 10 + Turborepo monorepo. Requires Node >= 22.

Structure

Directory	Purpose
`apps/studio`	Supabase Studio/Dashboard — Next.js (pages router), React 18
`apps/docs`	Documentation site
`apps/www`	Marketing website
`packages/ui`	Shared UI components (shadcn/ui based)
`packages/common`	Shared utilities and telemetry constants
`e2e/studio`	Playwright E2E tests for Studio

Common Commands

pnpm install                          # install dependencies
pnpm dev:studio                       # run Studio dev server
pnpm test:studio                      # run Studio unit tests (vitest)
pnpm --prefix e2e/studio run e2e       # run Studio E2E tests (playwright)
pnpm build --filter=studio             # build Studio
pnpm lint --filter=studio              # lint Studio
pnpm typecheck                        # typecheck all packages

Conventions

UI — import from 'ui', use _Shadcn_ suffixed variants for form primitives. Check packages/ui/index.tsx before creating new primitives.

Styling — Tailwind only, semantic tokens (bg-muted, text-foreground-light), no hardcoded colors.

Language — Use U.S. English everywhere.

Studio

Pages router. Co-locate sub-components with parent. Avoid barrel re-export files.

See studio-* skills for detailed studio conventions.

1.7 KiB Raw Permalink Blame History