Skip to content

Latest commit

 

History

History
162 lines (107 loc) · 5.66 KB

File metadata and controls

162 lines (107 loc) · 5.66 KB

Task Guardrail Pack

任务信息

  • 任务名称:
  • 目标项目:
  • 目标分支或版本:
  • 实际扫描分支或版本:
  • 扫描 commit:
  • 分支校验结果:一致 / 不一致 / 未知
  • 任务来源:
  • 生成时间:
  • 生成者:

基准校验

开始使用本护栏包前,先确认目标分支、实际扫描分支和扫描 commit 是否仍与当前开发工作区一致。

如果分支校验结果不是“一致”,或 coding agent 当前工作区已经切到其他分支,本护栏包不能直接使用。应先重新扫描目标分支,或把本文件标记为历史线索。

任务理解

这次任务要解决什么问题?

明确不做

这次任务不应该顺手修改什么?

  • 非目标 1:
  • 非目标 2:

禁止修改范围

这些范围默认只读,除非任务明确要求且有证据说明必须修改。

禁止或受限范围 原因 如果必须修改,需要满足什么条件
path/to/shared-or-common.ext 例如公共 API、公共模型、全局配置、跨模块工具 需要说明影响面、引用关系和回归验证方式
path/to/unrelated-module 非本任务目标模块 需要用户确认或明确代码证据

必须产物

把任务明确要求的工程产物写成可验收清单。没有完成这些产物时,即使主流程看起来可用,也不能视为完成。

产物 是否必须 验收标准 证据位置
API 封装 是/否 例如只迁移目标模块 API,不改公共 API
model/type 是/否 例如新增或维护模块私有类型,不允许全部使用 any
页面或业务入口改造 是/否 例如所有目标调用点都切到新实现
旧实现清理 是/否 例如确认无其他引用后再删除
测试或人工验证说明 是/否 例如覆盖关键旧规则和异常路径

类型 / Model 要求

如果任务涉及接口、数据结构、状态流转或模型迁移,必须明确类型要求。

  • 是否必须新增或维护本模块私有 model/type 文件:
  • 哪些请求参数需要类型:
  • 哪些响应结构需要类型:
  • 哪些字段允许暂时用 unknownany,原因是什么:
  • 是否禁止 API 方法全部返回 any
  • 类型来源:目标项目代码 / 现有模型 / 服务端或客户端参考实现 / 人工确认 / 推测待验证

最低要求:如果存在稳定的请求或响应结构,应建立明确类型;如果无法建立类型,必须说明原因和后续确认方式。

框架和返回结构确认

如果任务涉及框架迁移、接口封装、缓存、路由、权限或公共工具,必须先确认旧框架和新框架的行为差异。

调用或框架能力 旧行为 新行为 对本任务的影响 证据
例如普通请求方法 path/to/file.ext
例如静默请求方法 path/to/file.ext

必须特别确认:

  • 返回值是完整响应、业务数据、包装对象,还是错误时抛异常。
  • 成功状态、错误状态、空数据和异常路径如何表达。
  • 调用方原来依赖的是哪一层结构。
  • 迁移后是否需要保留原有判空、状态码、提示或兜底逻辑。

建议阅读路径

按推荐顺序列出 coding agent 应该先读的文件。

顺序 文件 为什么要读
1 path/to/file.ext
2 path/to/file.ext

相关业务规则

引用 Business Rule Card,并说明与本任务的关系。

规则 ID 规则标题 与任务的关系 置信度
BRC-...

高风险区域

列出这次任务中容易误改、漏改或需要特别小心的地方。

风险点 相关文件 风险说明 建议处理
path/to/file.ext

特殊分支和例外

  • 特殊分支 1:
  • 特殊分支 2:

历史线索

只记录与本任务有关的历史原因,不要堆砌无关 commit。

  • commit-hash
  • 相关 issue 或文档:

推荐修改策略

给 coding agent 的建议。

  • 优先修改:
  • 避免修改:
  • 推荐新增测试:
  • 需要人工确认:

旧代码删除条件

如果任务允许删除旧实现,必须满足以下条件后才能删除。

待删除对象 删除前引用检查 是否只被目标模块使用 删除风险 结论
path/to/old-code.ext 例如 rg "symbolName" 是/否/不确定 保留/删除/待确认

删除前必须确认:

  • 是否还有目标模块之外的引用。
  • 是否有动态调用、配置引用、字符串拼接、路由或构建脚本引用。
  • 是否存在历史兼容、灰度、回滚或多端复用需求。
  • 如果无法确认,应保留旧实现并记录风险,而不是为了“清理”强删。

必须验证的场景

场景 为什么重要 验证方式

不确定点

这些内容不能当作事实,需要 coding agent 或人工继续确认。

  • 不确定点 1:
  • 不确定点 2:

给 Coding Agent 的启动提示

可以直接复制给 coding agent:

请基于本 Task Guardrail Pack 完成任务。开始修改前,先确认你理解了相关业务规则、高风险区域、禁止修改范围、必须产物、类型/model 要求、框架返回结构和必须验证的场景。修改时优先采用最小改动,避免无关重构。若发现代码事实与护栏内容冲突,以代码事实为准,并在回复中明确指出冲突和你的判断依据。完成后请逐项说明必须产物是否满足,以及哪些验证已完成、哪些仍需人工确认。