mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-16 12:28:06 +00:00
docs: add directory readmes and agent guides
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
# References 目录 Agent 指南
|
||||
|
||||
## 目录职责
|
||||
|
||||
`docs/references/` 存放工程实践、技术栈、质量门禁、模板和检查清单。
|
||||
|
||||
这里的文档回答:
|
||||
|
||||
- 项目应该如何组织。
|
||||
- AI 编程应该如何设置硬门禁。
|
||||
- 常见技术栈如何选择和组合。
|
||||
- 工程经验如何变成可执行清单。
|
||||
|
||||
## 文件地图
|
||||
|
||||
```text
|
||||
references/
|
||||
├── README.md # 参考资料索引
|
||||
├── AGENTS.md # 本目录操作规则
|
||||
├── 工程实践.md # 架构、代码组织、开发经验、质量门禁与常见坑
|
||||
└── 技术栈.md # 技术栈选型、组合案例与学习路径
|
||||
```
|
||||
|
||||
## 修改规则
|
||||
|
||||
- 新增参考资料时,必须同步更新 `README.md`。
|
||||
- 检查清单、模板、质量门禁和经验类内容优先合并进 `工程实践.md`。
|
||||
- 技术选型、技术栈组合和学习路径优先合并进 `技术栈.md`。
|
||||
- 不在本目录写一次性研究笔记;新技术判断应先放入 `docs/research/`。
|
||||
|
||||
## 质量要求
|
||||
|
||||
- 参考文档必须可执行、可检查、可复用。
|
||||
- 门禁类内容尽量转成测试、CI、脚本、schema、类型或检查清单。
|
||||
- 不确定项必须标注 TODO,不能编造成熟结论。
|
||||
Reference in New Issue
Block a user