跳转至

开发工作流程

本文档在 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% 以上问题的开源项目,以便进行分叉、移植或封装。
  7. 如果经过验证的方法能满足需求,优先采用或移植该方法,而不是编写全新的代码。

  8. 先规划

  9. 使用 planner 智能体来创建实施计划
  10. 编码前生成规划文档:PRD、架构、系统设计、技术文档、任务列表
  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. 遵循约定式提交格式
  26. 提交信息格式和 PR 流程请参阅 git-workflow.md

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