40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
# Repository Guidelines
|
|
|
|
This document provides contributor guidance for this repository.
|
|
|
|
## Project Structure & Module Organization
|
|
- `app/`: Next.js App Router pages, layouts, and API routes (e.g., `app/api/...`).
|
|
- `components/`: Reusable UI components and app-level widgets.
|
|
- `lib/`: Shared utilities, API helpers, and domain logic.
|
|
- `convex/`: Convex backend functions, schema, and auth helpers.
|
|
- `public/`: Static assets served by Next.js.
|
|
- `docs/` and `scripts/`: Reference docs and maintenance scripts.
|
|
|
|
## Build, Test, and Development Commands
|
|
- `npm run dev`: Start the Next.js dev server.
|
|
- `npm run build`: Production build.
|
|
- `npm run start`: Run the production server locally after build.
|
|
- `npm run lint`: Run Next.js/ESLint linting.
|
|
|
|
## Coding Style & Naming Conventions
|
|
- TypeScript + React (Next.js App Router). Use 2-space indentation as seen in existing files.
|
|
- Prefer file and folder names in `kebab-case` and React components in `PascalCase`.
|
|
- Tailwind CSS is used for styling; keep class lists ordered for readability.
|
|
- Linting: `next lint` (no Prettier config is present).
|
|
|
|
## Testing Guidelines
|
|
- No dedicated test framework is configured yet.
|
|
- If you add tests, document the runner and add a script to `package.json`.
|
|
|
|
## Commit & Pull Request Guidelines
|
|
- Commit history uses Conventional Commits (e.g., `feat:`, `fix:`). Follow that pattern.
|
|
- Commit changes made during a request, and only include files touched for that request.
|
|
- PRs should include:
|
|
- Clear description of changes and motivation.
|
|
- Linked issue/task if available.
|
|
- Screenshots for UI changes (before/after if relevant).
|
|
|
|
## Security & Configuration Tips
|
|
- Copy `.env.example` to `.env.local` for local development.
|
|
- Never commit secrets (API keys, tokens). Keep them in `.env.local`.
|