-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
P2: Post-Launch IterateIterate after market validationIterate after market validation
Description
Background
To help AI coding assistants (Claude Code, GitHub Copilot, Cursor, etc.) better understand the project structure and development conventions, we need standardized guide files in the repository root.
Goals
1. Review and update CLAUDE.md
CLAUDE.md already exists. Review and ensure it covers:
- Project overview and architecture
- Monorepo structure
- Tech stack
- Development commands
- Key protocols (Session Key, Gateway WS)
- Coding conventions
- Known issues and pitfalls
- Verify content is in sync with latest codebase
2. Create AGENTS.md
Create AGENTS.md as a universal AI agent guide file (compatible with GitHub Copilot Workspace, Codex, and similar tools). It should include:
- One-line project description
- Directory structure overview
- Build and test commands
- Code style and conventions (TypeScript strict, CSS Variables, Zustand state management, etc.)
- PR / Commit conventions
- Security guidelines (no committed secrets, no hardcoded credentials, etc.)
- Consistent with
CLAUDE.mdbut formatted for different tools
Acceptance Criteria
-
CLAUDE.mdcontent is in sync with the current codebase -
AGENTS.mdexists in the repository root - No conflicting information between the two files
- AI assistants can correctly understand the project and generate code that follows conventions based on these files
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
P2: Post-Launch IterateIterate after market validationIterate after market validation