docs(zh-CN): update

This commit is contained in:
neo
2026-03-13 17:45:44 +08:00
parent f548ca3e19
commit 4c0107a322
88 changed files with 16872 additions and 280 deletions

View File

@@ -6,32 +6,33 @@
## 功能实现工作流程
0. **研究与复用** *(任何新实现之前强制进行)*
* **先进行 GitHub 代码搜索:** 在编写任何新内容之前,运行 `gh search repos``gh search code` 以查找现有的实现、模板和模式。
* **使用 Exa MCP 进行研究:** 在规划阶段使用 `exa-web-search` MCP 进行更广泛的研究、数据摄取和发现现有技术
* **检查包注册表:** 在编写工具代码之前,搜索 npm、PyPI、crates.io 和其他注册表。优先选择经过实战检验的库,而不是自己编写的解决方案
* **搜索可适配的实现:** 寻找能够解决 80% 以上问题并且可以分叉、移植或包装的开源项目
* 当满足要求时,优先采用或移植经过验证的方法,而不是编写全新的代码
0. **研究与复用** *(任何新实现前必须执行)*
* **先进行 GitHub 代码搜索:** 在编写任何新代码之前,运行 `gh search repos``gh search code` 以查找现有的实现、模板和模式。
* **其次查阅库文档:** 在实现之前,使用 Context7 或主要供应商文档来确认 API 行为、包的使用以及版本特定的细节
* **仅在以上两者不足时使用 Exa** 在 GitHub 搜索和主要文档之后,再使用 Exa 进行更广泛的网络研究或探索
* **检查包注册中心:** 在编写工具代码之前,先搜索 npm、PyPI、crates.io 和其他注册中心。优先选择经过实战检验的库,而不是自己动手实现
* **寻找可适配的实现:** 寻找能解决 80% 以上问题的开源项目,以便进行分叉、移植或封装
* 如果经过验证的方法能满足需求,优先采用或移植该方法,而不是编写全新的代码。
1. **先规划**
* 使用 **planner** 代理创建实施计划
* 编码前生成规划文档PRD、架构、系统设计、技术文档、任务列表
* 使用 **planner** 智能体来创建实施计划
* 编码前生成规划文档PRD、架构、系统设计、技术文档、任务列表
* 识别依赖项和风险
* 分解为多个阶段
2. **TDD 方法**
* 使用 **tdd-guide** 代理
* 先写测试 (RED)
* 实现以通过测试 (GREEN)
* 重构 (IMPROVE)
* 验证 80%+ 的覆盖率
* 使用 **tdd-guide** 智能体
*写测试RED
* 实现代码以通过测试GREEN
* 重构IMPROVE
* 验证 80% 以上的覆盖率
3. **代码审查**
* 编写代码后立即使用 **code-reviewer** 代理
* 处理 CRITICAL 和 HIGH 级别的问题
* 编写代码后立即使用 **code-reviewer** 智能体
* 解决 CRITICAL 和 HIGH 级别的问题
* 尽可能修复 MEDIUM 级别的问题
4. **提交与推送**
* 详细的提交信息
* 遵循约定式提交格式
* 关于提交信息格式和 PR 流程请参阅 [git-workflow.md](git-workflow.md)
* 提交信息格式和 PR 流程请参阅 [git-workflow.md](git-workflow.md)