开发工作流¶
本文件扩展 common/git-workflow.md,说明在 Git 操作之前执行的完整功能开发流程。
功能实现工作流描述了开发流水线:调研、规划、TDD、代码审查以及提交到 Git。
功能实现工作流¶
- 调研与复用 (在新实现之前必须执行)
- 首先进行 GitHub 代码搜索: 在编写任何新内容之前,运行
gh search repos和gh search code,查找现有实现、模板和模式。 - 然后查阅库文档: 使用 Context7 或供应商官方文档,在实现前确认 API 行为、包用法和版本特定细节。
- 仅当前两项不足时使用 Exa: 在 GitHub 搜索和官方文档之后,使用 Exa 进行更广泛的网络调研和发现。
- 检查包注册表: 在编写工具代码之前,搜索 npm、PyPI、crates.io 等注册表。优先选择经过验证的库,而不是手工解决方案。
- 查找可适配的实现: 寻找能够解决 80% 以上问题,并且可以 fork、移植或包装的开源项目。
-
如果满足要求,优先采用或移植经过验证的方法,而不是完全编写新代码。
-
先规划
- 使用 planner 代理创建实现计划
- 在编码前生成计划文档:PRD、架构、system_design、tech_doc、task_list
- 识别依赖关系和风险
-
拆分为阶段
-
TDD 方法
- 使用 tdd-guide 代理
- 先编写测试(RED)
- 实现以通过测试(GREEN)
- 重构(IMPROVE)
-
验证 80% 以上的覆盖率
-
代码审查
- 在编写代码后立即使用 code-reviewer 代理
- 处理 CRITICAL 和 HIGH 问题
-
尽可能修复 MEDIUM 问题
-
提交与推送
- 详细的提交信息
- 遵循 Conventional Commits 格式
-
关于提交信息格式和 PR 流程,请参阅 git-workflow.md
-
审查前检查
- 确认所有自动检查(CI/CD)均已通过
- 解决合并冲突
- 确认分支与目标分支保持最新状态
- 仅在这些检查通过后才请求审查
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 ev/ECC