Back to Details

report-bug

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Report a Compounding Engineering Plugin Bug

上报Compounding Engineering插件Bug

Report bugs encountered while using the compound-engineering plugin. This command gathers structured information and creates a GitHub issue for the maintainer.
上报使用compound-engineering插件时遇到的bug。该命令会收集结构化信息并为维护者创建一个GitHub Issue。

Step 1: Gather Bug Information

步骤1：收集Bug信息

Use the AskUserQuestion tool to collect the following information:
Question 1: Bug Category
  • What type of issue are you experiencing?
  • Options: Agent not working, Command not working, Skill not working, MCP server issue, Installation problem, Other
Question 2: Specific Component
  • Which specific component is affected?
  • Ask for the name of the agent, command, skill, or MCP server
Question 3: What Happened (Actual Behavior)
  • Ask: "What happened when you used this component?"
  • Get a clear description of the actual behavior
Question 4: What Should Have Happened (Expected Behavior)
  • Ask: "What did you expect to happen instead?"
  • Get a clear description of expected behavior
Question 5: Steps to Reproduce
  • Ask: "What steps did you take before the bug occurred?"
  • Get reproduction steps
Question 6: Error Messages
  • Ask: "Did you see any error messages? If so, please share them."
  • Capture any error output
使用AskUserQuestion工具收集以下信息：
问题1：Bug类别
  • 你遇到的是哪种类型的问题？
  • 选项：Agent无法工作、命令无法工作、Skill无法工作、MCP服务器问题、安装问题、其他
问题2：具体组件
  • 哪个具体组件受到了影响？
  • 询问受影响的agent、命令、skill或MCP服务器的名称
问题3：实际发生的情况（实际行为）
  • 询问：“当你使用该组件时发生了什么？”
  • 获取对实际行为的清晰描述
问题4：预期发生的情况（预期行为）
  • 询问：“你原本预期会发生什么？”
  • 获取对预期行为的清晰描述
问题5：复现步骤
  • 询问：“bug发生前你执行了哪些步骤？”
  • 获取复现步骤
问题6：错误信息
  • 询问：“你是否看到任何错误信息？如果有，请分享。”
  • 捕获任何错误输出

Step 2: Collect Environment Information

步骤2：收集环境信息

Automatically gather:
bash
undefined
自动收集：
bash
undefined

Get plugin version

Get plugin version

cat ~/.claude/plugins/installed_plugins.json 2>/dev/null | grep -A5 "compound-engineering" | head -10 || echo "Plugin info not found"
cat ~/.claude/plugins/installed_plugins.json 2>/dev/null | grep -A5 "compound-engineering" | head -10 || echo "Plugin info not found"

Get Claude Code version

Get Claude Code version

claude --version 2>/dev/null || echo "Claude CLI version unknown"
claude --version 2>/dev/null || echo "Claude CLI version unknown"

Get OS info

Get OS info

uname -a
undefined
uname -a
undefined

Step 3: Format the Bug Report

步骤3：格式化Bug报告

Create a well-structured bug report with:
markdown
undefined
创建结构清晰的bug报告，包含：
markdown
undefined

Bug Description

Bug描述

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]
  • 插件版本： [来自installed_plugins.json]
  • Claude Code版本： [来自claude --version]
  • 操作系统： [来自uname]

What Happened

实际发生情况

[Actual behavior description]
[实际行为描述]

Expected Behavior

预期行为

[Expected behavior description]
[预期行为描述]

Steps to Reproduce

复现步骤

  1. [Step 1]
  2. [Step 2]
  3. [Step 3]
  1. [步骤1]
  2. [步骤2]
  3. [步骤3]

Error Messages

错误信息

[Any error output]
[任何错误输出]

Additional Context

额外上下文

[Any other relevant information]
Reported via 
/report-bug
command
undefined
[任何其他相关信息]
通过
/report-bug
命令上报
undefined

Step 4: Create GitHub Issue

步骤4：创建GitHub Issue

Use the GitHub CLI to create the issue:
bash
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"
Note: If labels don't exist, create without labels:
bash
gh issue create \
  --repo EveryInc/compound-engineering-plugin \
  --title "[compound-engineering] Bug: [Brief description]" \
  --body "[Formatted bug report]"
使用GitHub CLI创建Issue：
bash
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"
注意： 如果标签不存在，跳过标签创建：
bash
gh issue create \
  --repo EveryInc/compound-engineering-plugin \
  --title "[compound-engineering] Bug: [Brief description]" \
  --body "[Formatted bug report]"

Step 5: Confirm Submission

步骤5：确认提交

After the issue is created:
  1. Display the issue URL to the user
  2. Thank them for reporting the bug
  3. Let them know the maintainer (Kieran Klaassen) will be notified
Issue创建完成后：
  1. 向用户显示Issue的URL
  2. 感谢用户上报bug
  3. 告知用户维护者Kieran Klaassen会收到通知

Output Format

输出格式

✅ 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.
✅ Bug报告提交成功！

Issue: https://github.com/EveryInc/compound-engineering-plugin/issues/[NUMBER]
标题: [compound-engineering] Bug: [描述]

感谢你帮助改进compound-engineering插件！
维护者会审核你的报告并尽快回复。

Error Handling

错误处理

  • If 
    gh
    CLI is not authenticated: Prompt user to run 
    gh auth login
    first
  • If issue creation fails: Display the formatted report so user can manually create the issue
  • If required information is missing: Re-prompt for that specific field
  • 如果
    gh
    CLI未认证：提示用户先运行
    gh auth login
  • 如果Issue创建失败：显示格式化后的报告，以便用户手动创建Issue
  • 如果缺少必填信息：重新提示用户提供该特定字段

Privacy Notice

隐私声明

This command does NOT collect:
  • Personal information
  • API keys or credentials
  • Private code from your projects
  • File paths beyond basic OS info
Only technical information about the bug is included in the report.
该命令不会收集：
  • 个人信息
  • API密钥或凭证
  • 项目中的私有代码
  • 除基础系统信息外的文件路径
报告中仅包含与bug相关的技术信息。