关于 trellis-before-dev
Trellis Skill,引导开发者在实现前阅读任务要求和适用的项目规范。它帮助明确变更范围,并要求先完成这些准备再编写代码。
主要功能
- 01阅读任务材料
- 02发现软件包及规范层
- 03确定适用指南
- 04查看共享指南
- 05界定非简单任务的变更范围
适用场景
- 01开始任务实现前做准备
- 02查找软件包对应的编码规范
- 03界定跨文件或跨层变更
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ mindfold-ai/ trellis --skill trellis-before-dev安装后在 Claude Code 中输入/trellis-before-dev确认已加载。
详细介绍
开始任务前,请先阅读相关开发指南。
执行以下步骤:
-
阅读当前任务材料:
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 -
对于非简单任务,请在编写代码前说明变更边界。 非简单任务是指涉及多个文件、跨越多个层级、变更公共接口,或编辑并非刚刚由你编写的代码。请写明:
- 当前行为与预期行为之间最小的差距
- 该行为实际所在的位置(而非最容易拦截的位置)
- 预计要修改哪些文件,以及修改每个文件的必要性
- 本任务明确不包含哪些工作
- 如果需要进行局部重构,如何证明其未改变行为
范围明确且较小的变更无需执行此步骤,可直接处理。
如果实际范围明显超出上述范围,请在继续之前说明原因。不得自行扩大变更范围。
-
了解需要遵循的编码标准和模式,然后继续执行开发计划。
此步骤为编写任何代码前的强制要求。
评论
支持 Markdown