mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-27 18:57:50 +00:00
docs: workflow - add development process directory
This commit is contained in:
@@ -162,6 +162,10 @@ git push origin develop
|
||||
│ ├── README.md # 在线表格链接
|
||||
│ └── AGENTS.md # prompts/ 目录规则
|
||||
│
|
||||
├── Workflow/ # 开发流程类 Markdown
|
||||
│ ├── README.md # 开发流程入口
|
||||
│ └── AGENTS.md # Workflow 目录规则
|
||||
│
|
||||
├── skills/ # 技能库(每个子目录一个 Skill)
|
||||
│ ├── README.md # skills 总览与索引
|
||||
│ ├── AGENTS.md # skills/ 目录规则
|
||||
|
||||
@@ -471,6 +471,7 @@ pip install -r tools/prompts-library/scripts/requirements.txt
|
||||
│ ├── auto-skill/ # 元技能核心
|
||||
│ └── claude-official-skills/ # Claude 官方 skills 软链接入口
|
||||
├── tools/ # 辅助工具、外部仓库与工具配置
|
||||
├── Workflow/ # 开发流程类 Markdown
|
||||
├── scripts/ # 自动化脚本
|
||||
├── metadata/ # 机器可读索引
|
||||
├── assets/ # 静态资产、外部资源入口与 AI 引用资产
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# Workflow Agent 指南
|
||||
|
||||
## 目录职责
|
||||
|
||||
`Workflow/` 存放项目开发流程类 Markdown,是开发顺序、质量门禁、版本控制和文档同步规则的流程入口。
|
||||
|
||||
## 修改规则
|
||||
|
||||
- 新增流程文档时,优先使用 Markdown。
|
||||
- 流程必须写成可执行步骤,避免只写抽象口号。
|
||||
- 涉及命令、路径、配置、CI、Git 操作时,必须与仓库当前事实一致。
|
||||
- 不在本目录保存密钥、Token、本地账号、真实私有项目配置或一次性日志。
|
||||
- 架构、目录、命令或质量门禁发生变化时,同步更新本目录和根 `README.md` / `AGENTS.md`。
|
||||
|
||||
## 验证
|
||||
|
||||
```bash
|
||||
make test
|
||||
```
|
||||
@@ -0,0 +1,29 @@
|
||||
# Workflow
|
||||
|
||||
本目录存放项目开发流程类 Markdown,用来沉淀可复用的执行顺序、检查节点和交付闭环。
|
||||
|
||||
## 目录
|
||||
|
||||
- [开发流程](#开发流程)
|
||||
- [维护规则](#维护规则)
|
||||
|
||||
## 开发流程
|
||||
|
||||
默认开发流程:
|
||||
|
||||
1. 明确目标:写清楚要做什么、不要做什么、成功标准是什么。
|
||||
2. 读取上下文:先看 README、AGENTS、相关目录说明和现有实现。
|
||||
3. 制定计划:把任务拆成可验证的小步骤,必要时先给用户确认。
|
||||
4. 执行修改:按最小影响面修改文件,不顺手重构无关内容。
|
||||
5. 运行门禁:至少运行 `make test`;涉及专项工具时补对应验证命令。
|
||||
6. 检查差异:用 `git diff` 确认没有混入临时文件、敏感信息或无关改动。
|
||||
7. 控制版本:使用语义清晰的 commit 记录阶段性成果。
|
||||
8. 推送远端:默认推送当前 `develop` 分支,并观察 GitHub Actions 结果。
|
||||
9. 同步文档:目录、命令、配置、流程变化必须同步 README / AGENTS / 对应索引。
|
||||
|
||||
## 维护规则
|
||||
|
||||
- 本目录只放流程类文档,不放一次性任务记录、日志、源码快照或私密配置。
|
||||
- 新增流程必须能被执行、检查和复用。
|
||||
- 流程中出现的命令、路径和配置必须能在仓库中找到依据。
|
||||
- 不确定项标注 TODO,并说明需要哪个文件或命令输出才能确认。
|
||||
Reference in New Issue
Block a user