mirror of
https://github.com/makeplane/plane.git
synced 2026-02-24 20:20:49 +01:00
25 lines
1.2 KiB
Markdown
25 lines
1.2 KiB
Markdown
|
# Agent Development Guide
|
||
|
|
|
||
|
|
## Commands
|
||
|
|
|
||
|
|
- `pnpm dev` - Start all dev servers (web:3000, admin:3001)
|
||
|
|
- `pnpm build` - Build all packages and apps
|
||
|
|
- `pnpm check` - Run all checks (format, lint, types)
|
||
|
|
- `pnpm check:lint` - ESLint across all packages
|
||
|
|
- `pnpm check:types` - TypeScript type checking
|
||
|
|
- `pnpm fix` - Auto-fix format and lint issues
|
||
|
|
- `pnpm turbo run <command> --filter=<package>` - Target specific package/app
|
||
|
|
- `pnpm --filter=@plane/ui storybook` - Start Storybook on port 6006
|
||
|
|
|
||
|
|
## Code Style
|
||
|
|
|
||
|
|
- **Imports**: Use `workspace:*` for internal packages, `catalog:` for external deps
|
||
|
|
- **TypeScript**: Strict mode enabled, all files must be typed
|
||
|
|
- **Formatting**: Prettier with Tailwind plugin, run `pnpm fix:format`
|
||
|
|
- **Linting**: ESLint with shared config, max warnings vary by package
|
||
|
|
- **Naming**: camelCase for variables/functions, PascalCase for components/types
|
||
|
|
- **Error Handling**: Use try-catch with proper error types, log errors appropriately
|
||
|
|
- **State Management**: MobX stores in `packages/shared-state`, reactive patterns
|
||
|
|
- **Testing**: All features require unit tests, use existing test framework per package
|
||
|
|
- **Components**: Build in `@plane/ui` with Storybook for isolated development
|