Skip to content

AGENTS.md

Latest commit

 

History

History
49 lines (37 loc) · 2.33 KB

AGENTS.md

File metadata and controls

49 lines (37 loc) · 2.33 KB

Repository Guidelines

Project Structure & Module Organization

  • src/core contains the layered Clean Architecture modules (domain, data, infra, main, presentation).
  • src/app hosts business modules and pages (feature-oriented).
  • src/assets stores local assets used by the app.
  • public contains static assets (also used by MSW workers).
  • scripts contains tooling like scripts/seed/index.mjs for mock data.
  • database contains project data artifacts (if needed for local setups).
  • dist is build output generated by Vite.

Build, Test, and Development Commands

  • pnpm install installs dependencies (Node >= 20).
  • pnpm dev starts the Vite dev server.
  • pnpm build runs tsc and produces a production build.
  • pnpm preview serves the production build locally.
  • pnpm lint runs ESLint on src/**/*.{ts,tsx}.
  • pnpm format runs Prettier using repository settings.
  • pnpm type:check runs TypeScript with tsconfig.app.json.
  • pnpm storybook:dev runs Storybook at localhost:6006.
  • pnpm seed:mock seeds mock data for local development.

Coding Style & Naming Conventions

  • Indentation is 2 spaces (per .editorconfig).
  • Use TypeScript strict style with type aliases; if you must use interface, prefix with I to satisfy ESLint.
  • Prefer function declarations for components and hooks.
  • File and folder names use kebab-case; components use PascalCase.
  • Hooks end with .hook.ts; stories use .stories.tsx.
  • Use absolute imports with @/* and @database/* (examples: @/core/..., @/app/...).
  • Formatting uses Prettier (semi: false, singleQuote: true) and ESLint; avoid console.log.

Testing Guidelines

  • No automated test suite is currently configured in this repo.
  • If you add tests, prefer *.test.ts or *.test.tsx colocated with the feature.
  • When adding or changing API behavior, update MSW handlers in src/core/mocks/handlers.

Commit & Pull Request Guidelines

  • Commit messages follow Conventional Commits (examples: feat: ..., fix: ..., chore: ..., optional scopes like feat(auth): ...).
  • PRs should include a clear summary, linked issue or ticket, and basic test steps.
  • Include screenshots or screen recordings for UI changes when applicable.

Agent-Specific Instructions

  • GEMINI.md and CODEX.md are steering files with project rules; keep changes aligned with them.