跳转至

开发工作流

本文件扩展 common/git-workflow.md,说明在 Git 操作之前执行的完整功能开发流程。

功能实现工作流描述了开发流水线:调研、规划、TDD、代码审查以及提交到 Git。

功能实现工作流

  1. 调研与复用 (在新实现之前必须执行)
  2. 首先进行 GitHub 代码搜索: 在编写任何新内容之前,运行 gh search repos 和 gh search code,查找现有实现、模板和模式。
  3. 然后查阅库文档: 使用 Context7 或供应商官方文档,在实现前确认 API 行为、包用法和版本特定细节。
  4. 仅当前两项不足时使用 Exa: 在 GitHub 搜索和官方文档之后,使用 Exa 进行更广泛的网络调研和发现。
  5. 检查包注册表: 在编写工具代码之前,搜索 npm、PyPI、crates.io 等注册表。优先选择经过验证的库,而不是手工解决方案。
  6. 查找可适配的实现: 寻找能够解决 80% 以上问题,并且可以 fork、移植或包装的开源项目。
  7. 如果满足要求,优先采用或移植经过验证的方法,而不是完全编写新代码。

  8. 先规划

  9. 使用 planner 代理创建实现计划
  10. 在编码前生成计划文档:PRD、架构、system_design、tech_doc、task_list
  11. 识别依赖关系和风险
  12. 拆分为阶段

  13. TDD 方法

  14. 使用 tdd-guide 代理
  15. 先编写测试(RED)
  16. 实现以通过测试(GREEN)
  17. 重构(IMPROVE)
  18. 验证 80% 以上的覆盖率

  19. 代码审查

  20. 在编写代码后立即使用 code-reviewer 代理
  21. 处理 CRITICAL 和 HIGH 问题
  22. 尽可能修复 MEDIUM 问题

  23. 提交与推送

  24. 详细的提交信息
  25. 遵循 Conventional Commits 格式
  26. 关于提交信息格式和 PR 流程,请参阅 git-workflow.md

  27. 审查前检查

  28. 确认所有自动检查(CI/CD)均已通过
  29. 解决合并冲突
  30. 确认分支与目标分支保持最新状态
  31. 仅在这些检查通过后才请求审查

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 ev/ECC