Skip to content

CHANGELOG.md

Latest commit

 

History

History
203 lines (144 loc) · 4.77 KB

CHANGELOG.md

File metadata and controls

203 lines (144 loc) · 4.77 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[2.1.0] - 2026-04-19

Added

🧠 Karpathy 四大编码原则

源自 Andrej Karpathy 的 LLM 编程观察，整合到 Step 5 编码环节：

  • ✅ 原则 1：先思考，再动手（Think Before Coding）

    • 不确定时先说假设，别闷头猜
    • 有多种理解时列出所有方案
    • 存在更简单方案时主动说出来
    • 搞不清楚时停下来问

  • ✅ 原则 2：简单至上（Simplicity First）

    • 不加没被要求的功能
    • 不为不可能的场景写错误处理
    • 200 行能搞定别写更多

  • ✅ 原则 3：手术式修改（Surgical Changes）

    • 不顺手改相邻代码
    • 没坏的东西不重构
    • 每一行改动都能追溯到需求

  • ✅ 原则 4：目标驱动执行（Goal-Driven Execution）

    • 模糊任务转化为可验证目标
    • 多步任务列计划 + 检查点
    • 循环验证直到通过

Changed

  • 更新 Skill.md Step 5，在 8 条编码纪律前增加 Karpathy 四大原则
  • 更新 README.md 工具包内容，增加 Karpathy 四大原则
  • 版本号更新至 v2.1

[1.1.0] - 2026-03-18

Added

🎬 新增实战案例

  • ✅ OpenClaw Portable Issue #53 修复案例
    • 多文件文档修复流程
    • 文档清理最佳实践
    • GitHub CLI 使用示例
    • 完整的复盘和经验总结

🔧 新增工具和指南

  • ✅ GitHub CLI 使用指南

    • 查看 Issue/PR
    • 评论和关闭 Issue
    • 查看 CI 状态
    • 合并 PR

  • ✅ 多文件修复注意事项

    • 同步修改多语言文档
    • 文档清理流程
    • 验证所有相关文件

  • ✅ 文档检查工具

    • 检查合并冲突标记
    • 检查冗余文件
    • 检查版本号一致性

📚 文档改进

  • ✅ 新增"文档修复"场景到适用场景表
  • ✅ 更新 Skill.md，增加实用工具章节
  • ✅ 更新 README.md，增加新案例链接

Changed

  • 优化 Skill.md 结构，增加更多实用内容
  • 改进实战案例章节，提供更多样化的示例

[1.0.0] - 2026-03-13

Added

🎯 核心特性

  • ✅ 完整的 9 步开发流程

    • Step 1: 读 issue（只理解，不改代码）
    • Step 2: 写"5行任务卡"（目标、边界、影响范围、非目标）
    • Step 3: 确定基线版本（从哪个 tag/文件开始改）
    • Step 4: 列改动点（只列具体改动）
    • Step 5: 编码（最小修改）
    • Step 6: 本地验证（4层测试：语法、导入、行为、回归）
    • Step 7: 看 diff（确认没偏题、没改过头）
    • Step 8: 写发布说明（修复项、验证项、未变更项）
    • Step 9: 最后复盘

  • ✅ 4 层验证体系

    • Layer 1: 语法验证（py_compile）
    • Layer 2: 导入验证
    • Layer 3: 行为验证（最小样例）
    • Layer 4: 回归验证

  • ✅ 15 项验收清单

    • A. 需求一致性（3项）
    • B. 技术正确性（4项）
    • C. 测试验证（4项）
    • D. 发布质量（4项）

  • ✅ 8 条编码纪律

    1. 先复制旧代码，再局部替换，不要凭记忆重写
    2. 改函数前，先通读函数的输入、输出、副作用
    3. 涉及数据结构变化时，先搜所有使用点
    4. 不要同时改逻辑和风格
    5. 不要在 bug fix 里做重构
    6. 不要修改未被需求要求的行为
    7. 不要在没有验证前说"修好了"
    8. 不要让 release note 超前于实际代码

📝 完整模板

  • ✅ 需求澄清模板

    • 任务类型
    • 问题现象
    • 正确行为
    • 影响范围
    • 非目标

  • ✅ 改动设计模板

    • 目标文件
    • 目标函数
    • 需要修改
    • 不应修改
    • 风险点
    • 验证方式

  • ✅ Commit Message 模板

  • ✅ Release Note 模板

📚 文档

  • ✅ SKILL.md - 完整的开发标准
  • ✅ README.md - 项目介绍
  • ✅ CONTRIBUTING.md - 贡献指南
  • ✅ CHANGELOG.md - 版本历史
  • ✅ docs/ - 详细文档
  • ✅ examples/ - 实战示例
  • ✅ templates/ - 模板文件

🎓 能力训练

  • ✅ 精准改动能力
  • ✅ 验证能力
  • ✅ 一致性能力
  • ✅ 收敛能力

Changed

  • N/A

Deprecated

  • N/A

Removed

  • N/A

Fixed

  • N/A

Security

  • N/A

Version History

Version Date Changes
2.1.0 2026-04-19 整合 Karpathy 四大编码原则
1.1.0 2026-03-18 新增实战案例、工具指南
1.0.0 2026-03-13 初始版本发布

Format: Keep a Changelog Versioning: Semantic Versioning