docs(project): 同步当前实现与协作约定
This commit is contained in:
33
AGENTS.md
33
AGENTS.md
@@ -69,6 +69,14 @@ Django 单体 + 独立 Agent Core + Docker Compose
|
||||
9. 完成内置工具系统。
|
||||
10. 补 Docker Compose 一键启动。
|
||||
|
||||
当前仓库状态说明:
|
||||
|
||||
- Django 单体骨架已完成。
|
||||
- 5 个预置场景 YAML 已接通首页和对话页。
|
||||
- Agent Core 已具备 Prompt 编排、结构化解析、工具注册和 RAG fallback / Chroma 双路径。
|
||||
- Chat、Documents、Audit 页面已经可以形成完整演示闭环。
|
||||
- 全量测试已覆盖主要模块行为,并默认隔离真实 LLM 网络调用。
|
||||
|
||||
## 编码约定
|
||||
|
||||
- Python 代码优先保持简单、直观、可讲解。
|
||||
@@ -79,6 +87,9 @@ Django 单体 + 独立 Agent Core + Docker Compose
|
||||
- 模型调用必须通过 LLM Provider,不允许散落在业务代码中。
|
||||
- 审计日志要记录成功和失败两种情况。
|
||||
- 不在日志中保存 API Key、密钥或敏感环境变量。
|
||||
- 新增或重构模块时,优先补清晰的中文注释,说明职责边界、输入输出和设计取舍。
|
||||
- 页面模板优先直接表达业务信息,不在模板中堆积复杂逻辑判断。
|
||||
- 测试优先覆盖服务层和核心编排逻辑,再由页面测试补齐关键展示行为。
|
||||
|
||||
## 文档约定
|
||||
|
||||
@@ -111,6 +122,14 @@ configs/
|
||||
- `README.md`
|
||||
- `docs/需求分析/1.V1总需求文档.md`
|
||||
- 相关模块需求文档
|
||||
- `AGENTS.md` 中的协作边界与当前实现状态
|
||||
|
||||
推荐同步文档的场景:
|
||||
|
||||
- 新增用户可见页面或流程。
|
||||
- 调整环境变量、生效方式或部署命令。
|
||||
- 修改 Agent Core 的输入输出合约。
|
||||
- 新增工具、审计字段或场景配置字段。
|
||||
|
||||
## 测试与验证约定
|
||||
|
||||
@@ -124,6 +143,20 @@ configs/
|
||||
- 审计日志能记录。
|
||||
- Docker Compose 可以启动。
|
||||
|
||||
当前默认验证命令:
|
||||
|
||||
```bash
|
||||
pytest
|
||||
python manage.py check
|
||||
docker compose config
|
||||
```
|
||||
|
||||
补充约定:
|
||||
|
||||
- 若本地 `.env` 存在真实模型密钥,测试仍应保持可离线执行。
|
||||
- 每完成一项功能或一轮重构后,应先跑相关测试,再跑全量测试或核心回归测试。
|
||||
- 完成改动后,按逻辑分组使用 Conventional Commit 风格提交到本地。
|
||||
|
||||
## 不优先做的事项
|
||||
|
||||
第一版不要优先做:
|
||||
|
||||
Reference in New Issue
Block a user