Developer Playbook (中文 + English)¶
1) 目标 / Goal¶
中文: 快速搭建本地开发环境,完成一次从项目创建到 Workbench 运行的端到端闭环,并能定位常见故障。
English: Set up local development quickly, complete one end-to-end flow from project creation to Workbench run, and troubleshoot common issues.
2) 最短路径 / Fast Path¶
3) 日常开发清单 / Daily Dev Checklist¶
- 拉取代码后执行 Alembic 迁移到 head。
- 启动 backend、frontend。
- 使用登录接口获取 token,验证项目 API。
- 在 Workbench 完成一轮 run,检查 runs/events。
- 若涉及 embedding 重试,验证 enqueue 与 fallback 两种模式。
4) 关键代码区域 / Key Areas¶
- Backend API:
app/api/v1 - Runtime:
app/runtime - Worker:
app/workers - Data models:
app/db/models.py - Frontend workbench:
frontend/src/views/WorkbenchView.vue
5) 提交前检查 / Pre-commit Checks¶
- 后端测试通过。
- 前端构建通过。
- 新增 API 有文档更新。
- 迁移脚本与模型变更一致。