name: workflow description: 用于实现特性的标准工作流,包括规范和规划文档。当开始一个新特性、规划实施或处理任何非平凡任务时使用。
标准工作流
- 首先思考问题,阅读代码库中的相关文件,并在 specs/[timestamp] [feature-name].md 编写计划,其中 [timestamp] 是格式为 YYYYMMDDThhmmss 的时间戳,[feature-name] 是特性的名称。
- 计划应包含待办事项列表,你可以在完成时勾选。
- 在开始工作之前,与我确认,我会验证计划。
- 然后,开始处理待办事项,边做边标记为完成。
- 请在每一步都给我一个高层次的解释,说明你做了哪些更改。
- 使每一个任务和代码更改都尽可能简单。我们希望避免任何大规模或复杂的更改。每一个更改都应影响尽可能少的代码。一切都是关于简单性。
- 最后,在 .md 文件中添加一个审查部分,总结你所做的更改以及任何其他相关信息。
规范放置
规范总是位于其作用域的根级别(不在 docs/ 内):
/specs/- 跨领域特性、架构决策、通用工具/apps/[app]/specs/- 特定应用的规范/packages/[pkg]/specs/- 包特定的规范
如有疑问,使用 /specs/。仅在规范确实属于那里时,移动到应用/包特定的位置。