23059a1de3
Some checks failed
CodeQL / Analyze (javascript) (push) Failing after 16s
CodeQL / Analyze (python) (push) Failing after 3s
i18n sync check / check:sync (push) Failing after 3s
React Doctor / react-doctor (push) Failing after 16s
Branch Build CE / Build-Push Admin Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge Admin Manifest (push) Has been cancelled
Branch Build CE / Build-Push Web Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge Web Manifest (push) Has been cancelled
Branch Build CE / Build-Push Space Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge Proxy Manifest (push) Has been cancelled
Branch Build CE / Merge Space Manifest (push) Has been cancelled
Branch Build CE / Prepare AIO Assets (push) Has been cancelled
Branch Build CE / Build Setup (push) Has been cancelled
Branch Build CE / Build-Push Live Collaboration Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge Live Collaboration Manifest (push) Has been cancelled
Branch Build CE / Build-Push API Server Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge API Server Manifest (push) Has been cancelled
Branch Build CE / Build-Push Proxy Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Build-Push AIO Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge AIO Manifest (push) Has been cancelled
Branch Build CE / Upload Build Assets (push) Has been cancelled
Branch Build CE / Build Release (push) Has been cancelled
1.8 KiB
1.8 KiB
Agent Development Guide
Commands
pnpm dev- Start all dev servers (web:3000, admin:3001)pnpm build- Build all packages and appspnpm check- Run all checks (format, lint, types)pnpm check:lint- OxLint across all packagespnpm check:types- TypeScript type checkingpnpm fix- Auto-fix format and lint issuespnpm turbo run <command> --filter=<package>- Target specific package/apppnpm --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: oxfmt, run
pnpm fix:format - Linting: OxLint with shared
.oxlintrc.jsonconfig - 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/uiwith Storybook for isolated development
Backend tests (Docker)
The Django/pytest suite for apps/api runs in an isolated stack defined by docker-compose-test.yml at the repo root.
Prereq (once): ./setup.sh — generates apps/api/.env from .env.example.
- Full suite:
docker compose -f docker-compose-test.yml up --build --abort-on-container-exit --exit-code-from api-tests - Subset:
docker compose -f docker-compose-test.yml run --rm api-tests pytest -m unit - Teardown:
docker compose -f docker-compose-test.yml down -v
See apps/api/tests/RUNNING_TESTS.md for the full walkthrough and troubleshooting; see apps/api/tests/TESTING_GUIDE.md for test conventions and fixtures.