Back to Easydict

变更历史

docs/histories/README.md

2.22.0859 B
Original Source

变更历史

docs/histories/ 记录已完成的实质性变更。仅分析任务如果没有产生仓库决策或文件 变更,则不需要记录历史。

规则

  • 每个 Issue、PR 或具有独立意义的任务使用一条历史记录。
  • 同一任务分多轮处理时,继续使用同一条历史记录。
  • 保持用户请求简洁,并移除机密信息、本地路径和原始日志。
  • 记录设计意图、受影响文件、验证结果和已知后续事项。
  • 存在执行计划时,链接对应的执行计划。
  • 历史文件统一命名为 YYYY-MM-DD-<slug>.md,其中 <slug> 使用小写 kebab-case;文件继续归档到 YYYY-MM/ 目录下。
  • 结构性标题统一使用中文;技术名词、代码标识和引用路径保留原文。

新建记录时使用 template.md,并将其归档到 YYYY-MM/ 下。