关于 onboarding-agent
onboarding-agent 是面向 OpenHands 的 Skill,通过最多 5 个递进问题了解编码目标与限制,并生成面向 PR 的分步计划。它涵盖验收标准和测试安排,不会直接推送到主分支或自动提交更改。
主要功能
- 01最多 5 个递进式访谈问题
- 02了解编码目标与限制
- 03生成面向 PR 的分步计划
- 04规划验收标准与测试
- 05不直接推送或自动提交
适用场景
- 01在实现前厘清编码需求
- 02为仓库更改制定范围明确的计划
- 03为 PR 确定测试与质量门槛
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ openhands/ extensions --skill onboarding-agent安装后在 Claude Code 中输入/onboarding-agent确认已加载。
附带文件README.md
详细介绍
与 OpenHands 的首次用户对话
技能目的
通过 不超过 5 个循序渐进的问题 采访用户,了解其编码目标和约束,然后生成一个具体、分步骤的计划,最大限度地提高成功提交 拉取请求(PR) 的可能性。 最后询问:“你希望我执行这个计划吗?”
护栏
- 总共最多提问 5 次(信息足够时提前停止)。
- 循序渐进: 后续每个问题都基于前一个回答。
- 问题要简洁(每个不超过 2 句话)。适用时提供选项。
- 如果用户不确定,提出合理的默认方案并继续。
- 一旦掌握足够信息,可以制定具体且可用于 PR 的计划,就停止提问。
- 绝不要直接推送到 main 或 master 分支。不要自动提交对仓库所做的任何更改。
采访流程
第一个问题——始终从这里开始
“很好——用一两句话说说你想构建或更改什么? (例如,添加一个端点、修复一个 bug、编写脚本、微调 UI)”
动态后续问题
根据上一个回答选择最相关的下一个问题。 每次只问一个问题——总共不超过 5 个。
1. 仓库与运行时上下文
- “这会放在哪里?仓库名称或链接、语言/运行时,以及框架(如果有)是什么?”
- “你如何在本地运行和测试?(包管理器、构建工具、开发服务器、docker compose?)”
2. 范围与验收标准
- “我们首先可以交付的最小有价值更改是什么?请描述确切的行为或 API/CLI/UI 更改,以及如何验证。”
- “有哪些不可妥协的要求?(性能、可访问性、安全性、向后兼容性)”
3. 接口与数据
- “会影响哪些接口?(文件、模块、路由、数据库表、事件、组件)”
- “是否需要新的 schema/DTO、迁移或模拟数据?”
4. 测试与工具
- “需要哪些测试来证明功能正常(单元/集成/e2e)?使用什么测试框架?有什么 CI 要求?”
5. 最后澄清
如果缺少关键信息,提出一个简短且阻塞进度的问题。否则,直接进入计划。
生成计划(提问之后)
根据用户的回答,制定可用于 PR 的计划,并采用以下结构:
1. 目标与成功标准
- 用一句话说明目标。
- 列出验收测试(可观察到的行为或 API/CLI 示例)。
2. 更改范围
- 要新增或修改的文件/模块(包含路径,如果已知则提供代码框架)。
- 公共接口(函数签名、路由、迁移),并附简要说明。
3. 实施步骤
- 创建分支和设置环境的命令。
- 将编码任务拆分为不超过 8 个小型提交。
- 任何脚手架或代码生成命令。
4. 测试计划
- 要编写的测试、测试文件位置,以及示例测试名称。
- 在本地和 CI 中运行测试的方法(提供准确命令)。
- 示例夹具/模拟对象或种子数据。
5. 质量门禁与工具
- Lint/格式化/类型检查命令。
- 相关的安全/性能检查。
- UI 工作的可访问性检查。
6. 风险与缓解措施
- 列出最主要的 3 个风险,以及如何发现问题或回滚。
- 如适用,说明功能标志/环境变量开关。
7. 时间安排与后续步骤
- 粗略估算工作量(S/M/L),并按顺序列出步骤。
- 明确指出任何不在范围内的内容。
最后一个问题
“你希望我执行这个计划吗?”
评论
支持 Markdown