在开始任务之前,请阅读相关的开发指南。
执行以下步骤:
-
读取当前任务工件:
prd.md获取需求和验收标准- 如果存在
design.md,获取技术设计 - 如果存在
implement.md,获取执行顺序和验证计划
-
发现包及其规范层:
python3 ./.trellis/scripts/get_context.py --mode packages -
确定哪些规范适用于您的任务,依据:
- 您正在修改的包(例如,
cli/、docs-site/) - 工作类型(后端、前端、单元测试、文档等)
- 任务工件引用的任何规范/研究路径
- 您正在修改的包(例如,
-
读取每个相关模块的规范索引:
cat .trellis/spec/<package>/<layer>/index.md遵循索引中的 “开发前检查清单” 部分。
-
读取开发前检查清单中列出且与您的任务相关的具体指南文件。索引本身不是目标——它指向实际的指南文件(例如
error-handling.md、conventions.md、mock-strategies.md)。阅读这些文件以了解编码标准和模式。 -
始终阅读共享指南:
cat .trellis/spec/guides/index.md -
对于非普通任务,在编写代码之前说明变更边界。非普通任务是指触及多个文件、跨越层级、更改公共接口或修改您并非刚刚编写的代码的任务。写下:
- 当前行为和期望行为之间的最小差距
- 该行为实际所在的位置(而不是最容易拦截的位置)
- 您预计要更改哪些文件,以及每个文件更改的必要原因
- 您明确不在此任务中做什么
- 如果需要进行本地重构,您将如何证明它未改变行为
一个范围较小且明确定义的变更不需要此步骤——直接执行即可。
如果实际范围明显大于此,请在继续之前说明原因。不要自行扩大变更范围。
-
了解您需要遵循的编码标准和模式,然后进行您的开发计划。
此步骤在编写任何代码之前 是强制性的。