Files

T

fe034fc262 [WEB-6106] chore: migrate CLAUDE.md to AGENTS.md with symlinks (#5517 )

* chore: migrate CLAUDE.md to AGENTS.md with symlinks
- Renamed all CLAUDE.md files to AGENTS.md (open standard)
- Created CLAUDE.md symlinks pointing to AGENTS.md for Claude Code compatibility
- Added .cursorrules symlink at root for Cursor support
- Removed directory structure sections from AGENTS.md files (file paths go stale)
- Preserved domain knowledge: models, endpoints, patterns, configuration

* chore: refactor AGENTS.md files for progressive disclosure

- Remove directory structures from authentication and db AGENTS.md (file paths go stale)
- Move 667-line design system guide from packages/tailwind-config/AGENTS.md to docs/design-system.md
- Replace tailwind-config AGENTS.md with 30-line summary linking to full docs

* chore: add AGENTS.md to web apps with design system links

- Add AGENTS.md for apps/web, apps/admin, apps/space
- Link to docs/design-system.md for Canvas/Surface/Layer patterns
- Create CLAUDE.md symlinks for Claude Code compatibility

* chore: add docs/TYPESCRIPT.md and link from all TS packages

- Create docs/TYPESCRIPT.md with modern TypeScript conventions (5.0+)
- Rename docs/*.md files to CONSTANT_CASE
- Add AGENTS.md to all TypeScript packages with links to docs
- Add AGENTS.md to apps/live and apps/relay
- Update app AGENTS.md files with TypeScript and feature doc links
- Link CALENDAR_IMPLEMENTATION.md from apps/web
- Link OIDC_GROUP_SYNCING.md from apps/api/plane/authentication
- Delete unused todesktop-implementation-guide.md
- Create CLAUDE.md symlinks for all new AGENTS.md files

* fix: claude.md files symlinks

---------

Co-authored-by: sriramveeraghanta <[email protected]>

2026-02-02 16:42:43 +05:30

799 B

Raw Blame History

API Application

Django REST API backend for Plane.

Stack

Django 4.x + Django REST Framework
PostgreSQL, Redis, Celery + RabbitMQ
GraphQL via Strawberry

Commands

python manage.py runserver     # Dev server
python manage.py migrate       # Run migrations
pytest                         # Run tests
pytest -m unit                 # Unit tests only
pytest -m contract             # Contract tests only
celery -A plane worker -l info # Celery worker

Test Markers

unit - Models, serializers, utilities
contract - API endpoints
smoke - Critical functionality
slow - May be skipped in CI

Environment

Copy .env.example to .env. Key variables: DATABASE_URL, REDIS_URL, SECRET_KEY.

See plane/AGENTS.md for Django project structure details.

799 B Raw Blame History