代码开发原子操作
代码开发的原子操作 - 调研、实现、测试、文档
系统级合规规则
- •遵循项目代码规范
- •优先编写测试 (TDD 思维)
- •保持代码简单直观 (KISS 思维)
操作定义
1. 调研 (investigate)
- •描述: 理解需求与上下文,识别相关代码和依赖
- •提醒: 理解需求后再开始编码,识别相关文件和依赖 Issue
- •检查点:
- •阅读并理解 Issue 描述
- •识别相关代码文件
- •检查依赖 Issue 状态
- •评估技术可行性
- •输出: 技术方案草稿、风险清单
2. 实现 (implement)
- •描述: 实现代码变更
- •提醒: 遵循项目代码规范,小步提交,处理边界情况
- •检查点:
- •遵循项目代码规范
- •编写/更新必要的文档
- •处理边界情况
- •保持代码可审查性(单次提交 < 400 行)
3. 测试 (test)
- •描述: 运行测试确保代码质量
- •提醒: 所有测试必须通过,检查测试覆盖率
- •检查点:
- •编写/更新单元测试
- •运行测试套件 (pytest, cargo test, etc.)
- •修复失败的测试
- •检查测试覆盖率
- •合规规则: 所有单元测试必须通过后才能提交
4. 文档 (document)
- •描述: 更新文档
- •提醒: 代码变更必须同步更新文档
- •检查点:
- •更新代码注释
- •更新相关文档
- •更新 CHANGELOG(如适用)