尧图网站设计 尧图网站设计YAOTU DESIGN
ARTICLE DETAIL

资讯详情

深耕网站设计与一线实操的经验洞察。

HumanLayer Skills 中 response-template.md 如何定义 PR body 输出格式:新手完整指南

HumanLayer Skills 中 response-template.md 如何定义 PR body 输出格式:新手完整指南 HumanLayer Skills 中 response-template.md 如何定义 PR body 输出格式新手完整指南【免费下载链接】skills项目地址: https://gitcode.com/GitHub_Trending/skills53/skills在 HumanLayer Skills 这个开源项目中response-template.md是一个看似不起眼、却决定 CI Agent 产出质量的关键文件。它用一份固定模板明确规定了编码代理Coding Agent在自动提交 PR 时其PR bodyPR 描述正文的输出格式——包括展示哪些信息、按什么顺序、用什么排版。本文将带你快速理解这个 PR 输出格式模板的设计思路以及如何为自动化任务自定义一份属于自己的 PR body 模板。为什么 AI 代理的 PR body 需要固定格式HumanLayer Skills 里的技能Skills大多用于无人值守的 CI 自动化场景定时工作流启动编码代理 → 代理修改代码 → 提交并创建 PR → 人类审查合并。关键机制在于代理运行结束时的最后一条回复会被工作流提取出来直接作为 PR 的正文见 SKILL.md 中get the final response into/tmp/pr-body.md的设计。如果没有模板约束代理的输出会时详细时简略、格式飘忽不定审查者每次都要重新猜它到底改了什么、风险有多大。response-template.md正是解决这个问题的格式契约。response-template.md 在项目中位于哪里项目里有两份代表性的模板文件分别展示了两种定位文件角色response-template.md模板范例库提供修复、生成、重构三类任务的 PR body 模板 编写准则response-template.md实战完整模板某具体技能收窄 React 组件 prop 类型真正使用的 PR body 格式按照项目约定技能目录下的references/子目录存放长模板和示例SKILL.md只负责指示代理去读它。例如 skill-template.md 的Format the response步骤写道When running as a CI agent, format your final response according toreferences/response-template.md. This response becomes the PR body.模板的核心设计5 条编写准则design-control-loop 技能中的模板文件末尾给出了 5 条 Guidelines是写好 PR body 格式的精髓摘要数字置顶Lead with summary stats——审查者第一眼就要知道本次改动的范围比如共处理 12 个问题修复 8 个 / 忽略 3 个 / 跳过 1 个按结果类型分组——Fixed、Ignored、Skipped、Created 分开呈现一眼扫清状态风险等级醒目标注HIGH / medium / low——帮助审查者优先处理高风险变更提供验证步骤——中高风险的改动必须附上怎么手工验证保持可扫读scannable——多用表格、标题、列表避免大段文字。三大现成模板修复、生成、重构模板文件为最常见的三类代理任务各给了一份开箱即用的 PR body 结构摘自 response-template.md1️⃣ 修复/迁移任务Fix/Migration先给统计摘要再逐个问题展开每个问题固定 4 个字段文件、摘要、解决方式、风险。Finished processing N react-doctor issues: - resolved: X - ignored: Y - skipped: Z ## Issue 1 - File(s): path/to/file.ts - Summary: [问题描述] - Resolution: FIXED. [修复说明] - Risk: HIGH - Manual verification: [验证步骤]2️⃣ 代码生成任务Generation用表格列出产出物 验证结果Generated N new tests: | File | Description | Status | |------|-------------|--------| | path/to/new-file.ts | [生成了什么] | Created | ## Validation - Typecheck: PASS - Tests: PASS3️⃣ 重构任务Refactor用 Before / After 对照 风险等级明确行为预期不变### path/to/file.ts - Before: [旧模式] - After: [新模式] - Risk: low ## Validation - No behavior changes expected模板变量让同一份模板适配任意任务模板文件还定义了 4 个占位符变量写入自己模板时可直接替换变量含义tool-name发现问题所用的 CLI 工具或流程artifact-type代理产出的产物类型测试、类型、文档等task-name代理任务名称date当前日期MM/DD 格式比如 agent-narrow-component-props.yml 对应的记忆文件命名就沿用了任务名 日期的约定。实战模板长什么样narrow-react-prop-types 案例narrow-react-prop-types 技能 的模板展示了为具体任务定制的完整效果其 PR body 由 6 个固定区块组成Summary一句话 数字已收窄 N 个组件的 propsChanges Made表格列出每个组件、文件、具体改动和理由Live Call Sites Checked列出佐证为什么这样改的真实调用点Show your workSupport Code Updated说明 Stories/测试做了哪些配套修改Validation勾选式验证结果typecheck、quality 命令Risk Assessment风险等级 理由。值得注意的是SKILL.md 的工作流把按模板格式化回复列为正式步骤第 11 步 Format the response确保代理不会漏掉这个动作。自己编写 response-template.md 的最快方法如果你想在自己的仓库落地一套 HumanLayer 风格的代理循环可以遵循三步法第 1 步选骨架。从 design-control-loop 的模板范例库 中按任务类型修复/生成/重构挑一个最接近的结构第 2 步问审查者需要什么。HumanLayer 的 build-iterated-agentic-loop 技能 在搭建循环时会专门询问摘要统计风险等级验证步骤文件清单按需增删区块第 3 步挂进技能。把定制后的模板放到技能目录的references/response-template.md并在SKILL.md的工作流最后一步指示代理读取并遵循该模板你的最终回复就是 PR body——这正是 skill-template.md 提供的标准写法。常见误区与避坑清单误区正确做法让代理自由发挥写 PR 描述模板即契约结构固定、信息必填只写改了什么必须附为什么这么改如 live call sites 证据缺少验证结果附上 typecheck / test 等命令的 PASS 状态全部标低风险按 HIGH / medium / low 分级并附验证步骤模板写得很长很啰嗦用表格和列表保持扫读友好总结response-template.md是 HumanLayer Skills 自动化体系中的输出格式契约它把代理如何向人类汇报工作标准化成一份 PR body 模板让每一次自动 PR 都摘要清晰、风险可见、验证可查。理解它的 5 条准则和三大任务模板你就能为自己的自动化任务快速定制出高质量的 PR 描述格式。如果想体验完整的搭建流程循环设计 → 技能编写 → 工作流接线可以从 design-control-loop 技能 开始读起。【免费下载链接】skills项目地址: https://gitcode.com/GitHub_Trending/skills53/skills创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表