Skip to content

AGENTS.md

Latest commit

 

History

History
55 lines (42 loc) · 3.77 KB

AGENTS.md

File metadata and controls

55 lines (42 loc) · 3.77 KB
Raw

Edge React GUI - Agent Guidelines

Package Manager

  • Use npm for all package management and script execution
  • npm ci - Install dependencies from the lockfile (CI-style, reproducible)
  • npm install <package> - Add new dependency
  • npm install -D <package> - Add dev dependency

Build/Test/Lint Commands

  • npm run lint - Run ESLint on entire codebase
  • npm run fix - Auto-fix linting issues and dedupe the dependency tree
  • npm test - Run Jest tests (single run)
  • npm run watch - Run Jest tests in watch mode
  • npm test -- --testNamePattern="test name" - Run specific test by name
  • npm run verify - Run lint, typechain, tsc, and test (full verification)
  • npm run precommit - Full pre-commit check (localize, lint-staged, tsc, test)
  • tsc - TypeScript type checking (via package.json script)

Code Style Guidelines

  • Formatting: Prettier with single quotes, no semicolons, no trailing commas, 80 char width
  • Imports: Use simple-import-sort plugin for automatic import sorting
  • Types: TypeScript required, no allowJs, prefer explicit types over any
  • React: Use functional components with hooks, prefer useHandler over useCallback
  • Naming: camelCase for variables/functions, PascalCase for components/types
  • Files: .tsx for React components, .ts for utilities/hooks
  • Error Handling: Use proper error boundaries, avoid throwing in render
  • Text Components: Use EdgeText, Paragraph, SmallText, WarningText instead of raw text
  • Component Reuse: Strongly prefer reusing existing shared components over building new ones or dropping to raw library primitives. Before adding UI, look for a component that already covers the need (e.g. text via EdgeText), and keep color, sizing, and styling driven by useTheme() rather than hard-coded per call site. When nothing suitable exists, add a reusable, themed definition instead of a one-off
  • Spacing: Keep a minimum of 1rem TOTAL space between an element and its neighbors, including screen edges. "Total" is the sum contributed across nearby and parent elements, so examine them rather than each element in isolation: scene-edge padding from SceneWrapper/SceneContainer (DEFAULT_MARGIN_REM, 0.5rem) plus an element's own 0.5rem margins via Space/useSpaceStyle compose to the 1rem total. An explicit override always takes precedence: the "unless otherwise specified" escape hatch applies to every case, screen edges included. The only built-in exception is flex layouts, which rely on flex gap and alignment for sibling spacing; even there, the 1rem screen-edge minimum still applies. Express spacing in rem through the layout primitives instead of hard-coded pixel margins
  • Hooks: Custom hooks in src/hooks/, follow use* naming convention
  • Testing: Jest with React Native Testing Library, tests in __tests__/ directories

Git Conventions

Commit Messages

  • Subject: Imperative mood, capitalize first letter, max 50 chars, no period
  • Body: Explain what/why (not how), wrap at 72 chars, separate from subject with blank line
  • Clean commits: Each commit should be standalone, build successfully, and improve code
  • Rebasing: Use interactive rebase to split, squash, and reorder commits before PR

Pull Requests

  • Future commits: Use "future! branch-name" for feature dependencies not yet merged
  • Draft PRs: Mark PRs with future commits as draft until dependencies are merged
  • Fixup commits: Use git commit --fixup <hash> for PR feedback, then squash with git rebase -i --autosquash

Branch Dependencies

  • Create pseudo-merge commits with "future! branch-name" for dependent features
  • Use git rebase --onto to update dependent branches when base changes
  • Remove future commits by rebasing onto master once dependencies are merged