The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
chore: add agents file (#1991)
David Nguyendbf10e5b7b30
diff --git a/AGENTS.md b/AGENTS.mdnew file mode 100644index 000000000..b6fba867d--- /dev/null+++ b/AGENTS.md@@ -0,0 +1,57 @@+# Agent Guidelines for Documenso++## Build/Test/Lint Commands++- `npm run build` - Build all packages+- `npm run lint` - Lint all packages+- `npm run lint:fix` - Auto-fix linting issues+- `npm run test:e2e` - Run E2E tests with Playwright+- `npm run test:dev -w @documenso/app-tests` - Run single E2E test in dev mode+- `npm run test-ui:dev -w @documenso/app-tests` - Run E2E tests with UI+- `npm run format` - Format code with Prettier+- `npm run dev` - Start development server for Remix app++## Code Style Guidelines++- Use TypeScript for all code; prefer `type` over `interface`+- Use functional components with `const Component = () => {}`+- Never use classes; prefer functional/declarative patterns+- Use descriptive variable names with auxiliary verbs (isLoading, hasError)+- Directory names: lowercase with dashes (auth-wizard)+- Use named exports for components+- Never use 'use client' directive+- Never use 1-line if statements+- Structure files: exported component, subcomponents, helpers, static content, types++## Error Handling & Validation++- Use custom AppError class when throwing errors+- When catching errors on the frontend use `const error = AppError.parse(error)` to get the error code+- Use early returns and guard clauses+- Use Zod for form validation and react-hook-form for forms+- Use error boundaries for unexpected errors++## UI & Styling++- Use Shadcn UI, Radix, and Tailwind CSS with mobile-first approach+- Use `<Form>` `<FormItem>` elements with fieldset having `:disabled` attribute when loading+- Use Lucide icons with longhand names (HomeIcon vs Home)++## TRPC Routes++- Each route in own file: `routers/teams/create-team.ts`+- Associated types file: `routers/teams/create-team.types.ts`+- Request/response schemas: `Z[RouteName]RequestSchema`, `Z[RouteName]ResponseSchema`+- Only use GET and POST methods in OpenAPI meta+- Deconstruct input argument on its own line+- Prefer route names such as get/getMany/find/create/update/delete+- "create" routes request schema should have the ID and data in the top level+- "update" routes request schema should have the ID in the top level and the data in a nested "data" object++## Translations & Remix++- Use `<Trans>string</Trans>` for JSX translations from `@lingui/react/macro`+- Use `t\`string\`` macro for TypeScript translations+- Use `(params: Route.Params)` and `(loaderData: Route.LoaderData)` for routes+- Directly return data from loaders, don't use `json()`+- Use `superLoaderJson` when sending complex data through loaders such as dates or prisma decimals