关于 report-bug
report-bug 是用于报告 compound-engineering 插件问题的命令,会收集结构化的复现与环境信息,并通过 GitHub CLI 创建维护者问题单。
主要功能
- 01收集问题类别与组件
- 02记录实际和预期行为
- 03整理复现步骤与错误
- 04收集版本及系统信息
- 05通过 GitHub CLI 创建问题单
适用场景
- 01报告 Agent 或命令故障
- 02提交技能或 MCP 服务问题
- 03反馈安装问题并附环境信息
MCP 相关
此命令会收集 MCP 服务相关故障信息,并将报告提交到 GitHub;README 未说明其连接或管理 MCP 服务的能力。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ everyinc/ compound-engineering-plugin --skill report-bug安装后在 Claude Code 中输入/report-bug确认已加载。
详细介绍
报告复合工程插件 Bug
报告使用 compound-engineering 插件时遇到的 Bug。此命令会收集结构化信息,并为维护者创建 GitHub issue。
第 1 步:收集 Bug 信息
使用 AskUserQuestion 工具收集以下信息:
问题 1:Bug 类别
- 你遇到的是哪种问题?
- 选项:Agent 无法工作、命令无法工作、技能无法工作、MCP 服务问题、安装问题、其他
问题 2:具体组件
- 受影响的是哪个具体组件?
- 询问 Agent、命令、技能或 MCP 服务的名称
问题 3:发生了什么(实际行为)
- 询问:“使用此组件时发生了什么?”
- 清楚描述实际行为
问题 4:应该发生什么(预期行为)
- 询问:“你原本预期会发生什么?”
- 清楚描述预期行为
问题 5:复现步骤
- 询问:“Bug 发生前,你执行了哪些步骤?”
- 获取复现步骤
问题 6:错误消息
- 询问:“你看到任何错误消息了吗?如果有,请分享。”
- 收集所有错误输出
第 2 步:收集环境信息
自动收集:
# Get plugin version
cat ~/.claude/plugins/installed_plugins.json 2>/dev/null | grep -A5 "compound-engineering" | head -10 || echo "Plugin info not found"
# Get Claude Code version
claude --version 2>/dev/null || echo "Claude CLI version unknown"
# Get OS info
uname -a
第 3 步:整理 Bug 报告
创建结构清晰的 Bug 报告,包含:
## Bug Description
**Component:** [Type] - [Name]
**Summary:** [Brief description from argument or collected info]
## Environment
- **Plugin Version:** [from installed_plugins.json]
- **Claude Code Version:** [from claude --version]
- **OS:** [from uname]
## What Happened
[Actual behavior description]
## Expected Behavior
[Expected behavior description]
## Steps to Reproduce
1. [Step 1]
2. [Step 2]
3. [Step 3]
## Error Messages
[任何错误输出]
## Additional Context
[Any other relevant information]
---
*Reported via `/report-bug` command*
第 4 步:创建 GitHub Issue
使用 GitHub CLI 创建 issue:
gh issue create \
--repo EveryInc/compound-engineering-plugin \
--title "[compound-engineering] Bug: [Brief description]" \
--body "[Formatted bug report from Step 3]" \
--label "bug,compound-engineering"
**注意:**如果标签不存在,则不添加标签直接创建:
gh issue create \
--repo EveryInc/compound-engineering-plugin \
--title "[compound-engineering] Bug: [Brief description]" \
--body "[Formatted bug report]"
第 5 步:确认提交
创建 issue 后:
- 向用户显示 issue URL
- 感谢用户报告 Bug
- 告知用户维护者(Kieran Klaassen)会收到通知
输出格式
✅ Bug report submitted successfully!
Issue: https://github.com/EveryInc/compound-engineering-plugin/issues/[NUMBER]
Title: [compound-engineering] Bug: [description]
Thank you for helping improve the compound-engineering plugin!
The maintainer will review your report and respond as soon as possible.
错误处理
- 如果
ghCLI 未通过身份验证:提示用户先运行gh auth login - 如果创建 issue 失败:显示格式化后的报告,方便用户手动创建 issue
- 如果缺少必填信息:重新询问相应字段
隐私声明
此命令不会收集:
- 个人信息
- API 密钥或凭据
- 项目中的私有代码
- 超出基本操作系统信息范围的文件路径
报告中只包含与 Bug 相关的技术信息。
评论
支持 Markdown