qzl
54 lines
2.0 KiB
Markdown
54 lines
2.0 KiB
Markdown
# Project Development Guide
|
|
|
|
This file serves as the entry point for project development, directing to appropriate constraint files based on development context.
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
social-app/
|
|
├── apps/ # Flutter mobile app
|
|
├── backend/ # FastAPI backend service
|
|
├── infra/ # Infrastructure (Docker, deployment scripts)
|
|
└── docs/ # Documentation and design/planning artifacts
|
|
```
|
|
|
|
## Rules Hierarchy
|
|
|
|
Follow this hierarchy when developing:
|
|
|
|
```
|
|
├── This file (root AGENTS.md) # Project-level entry
|
|
│ ├── backend/AGENTS.md # Backend-specific rules
|
|
│ └── apps/AGENTS.md # Frontend-specific rules
|
|
```
|
|
|
|
## Development Guidance
|
|
|
|
| Development Context | Follow Rules |
|
|
|--------------------|--------------|
|
|
| Backend Python dev | [backend/AGENTS.md](backend/AGENTS.md) |
|
|
| Flutter mobile dev | [apps/AGENTS.md](apps/AGENTS.md) |
|
|
| Infrastructure/ops | This file + infra/ directory conventions |
|
|
| API doc changes | Sync to `docs/runtime/runtime-route.md` |
|
|
|
|
## Backend Startup
|
|
|
|
**Always use `./infra/scripts/app.sh` to start/stop the backend.** Do not start uvicorn directly.
|
|
**Always use `./logs/*.log` to check the backend log output.**
|
|
|
|
## Git Workflow
|
|
|
|
- Default branch: `dev`
|
|
- Feature development: use worktree `git worktree add -b feature/xxx ../feature-xxx dev`
|
|
- Never develop directly on `main`
|
|
- **Never push to remote unless explicitly requested by user**
|
|
|
|
## Skills (Domain Knowledge)
|
|
|
|
| Skill | Purpose | When to Use |
|
|
|-------|---------|-------------|
|
|
| **ag-ui** | AG-UI protocol for agent-user interaction | Agent chat, streaming events, tool calls, state sync |
|
|
| **agentscope-skill** | AgentScope framework reference and examples | AgentScope multi-agent orchestration, API usage, implementation patterns |
|
|
|
|
**Usage**: Reference skills by name (e.g., "use the `ag-ui` skill") in development rules. Skills provide complete documentation, examples, and best practices.
|