Back to Details

report-bug-ce

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Report a Compound Engineering Plugin Bug

上报Compound Engineering插件Bug

Report bugs encountered while using the compound-engineering plugin. This skill gathers structured information and creates a GitHub issue for the maintainer.
本文介绍如何上报使用compound-engineering插件时遇到的Bug。该Skill会收集结构化信息并为维护者在GitHub上创建Issue。

Step 1: Gather Bug Information

步骤1：收集Bug信息

Ask the user the following questions (using the platform's blocking question tool — e.g., 
AskUserQuestion
in Claude Code, 
request_user_input
in Codex, 
ask_user
in Gemini — or present numbered options and wait for a reply):
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
向用户询问以下问题（使用平台的阻塞式提问工具——例如Claude Code中的
AskUserQuestion
、Codex中的
request_user_input
、Gemini中的
ask_user
——或者展示编号选项并等待回复）：
问题1：Bug类别
  • 你遇到的是什么类型的问题？
  • 选项：Agent无法正常工作, 命令无法执行, Skill无法正常工作, MCP服务器问题, 安装问题, 其他
问题2：具体组件
  • 受影响的具体组件是什么？
  • 询问受影响的Agent、命令、Skill或MCP服务器的名称
问题3：实际发生的情况（实际行为）
  • 询问：“你使用该组件时发生了什么？”
  • 获取对实际行为的清晰描述
问题4：预期发生的情况（预期行为）
  • 询问：“你原本预期会发生什么？”
  • 获取对预期行为的清晰描述
问题5：复现步骤
  • 询问：“Bug出现前你执行了哪些步骤？”
  • 获取复现步骤
问题6：错误信息
  • 询问：“你是否看到任何错误信息？如果有，请提供。”
  • 捕获所有错误输出

Step 2: Collect Environment Information

步骤2：收集环境信息

Automatically gather environment details. Detect the coding agent platform and collect what is available:
OS info (all platforms):
bash
uname -a
Plugin version: Read the plugin manifest or installed plugin metadata. Common locations:
  • Claude Code: 
    ~/.claude/plugins/installed_plugins.json
  • Codex: 
    .codex/plugins/
    or project config
  • Other platforms: check the platform's plugin registry
Agent CLI version: Run the platform's version command:
  • Claude Code: 
    claude --version
  • Codex: 
    codex --version
  • Other platforms: use the appropriate CLI version flag
If any of these fail, note "unknown" and continue — do not block the report.
自动收集环境详情。检测编码Agent平台并收集可用信息：
操作系统信息（所有平台）：
bash
uname -a
插件版本： 读取插件清单或已安装插件的元数据。常见位置：
  • Claude Code: 
    ~/.claude/plugins/installed_plugins.json
  • Codex: 
    .codex/plugins/
    或项目配置文件
  • 其他平台：查看平台的插件注册表
Agent CLI版本： 运行平台的版本命令：
  • Claude Code: 
    claude --version
  • Codex: 
    codex --version
  • 其他平台：使用相应的CLI版本参数
如果上述任何操作失败，记录为“未知”并继续流程——不要阻塞报告提交。

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 plugin manifest/registry]
  • Agent Platform: [e.g., Claude Code, Codex, Copilot, Pi, Kilo]
  • Agent Version: [from CLI version command]
  • OS: [from uname]
  • 插件版本： [来自插件清单/注册表]
  • Agent平台： [例如：Claude Code, Codex, Copilot, Pi, Kilo]
  • Agent版本： [来自CLI版本命令]
  • 操作系统： [来自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-ce
skill
undefined
[其他相关信息]
通过
/report-bug-ce
Skill上报
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: [简要描述]" \
  --body "[步骤3中格式化后的Bug报告]" \
  --label "bug,compound-engineering"
注意： 如果标签不存在，跳过标签创建：
bash
gh issue create \
  --repo EveryInc/compound-engineering-plugin \
  --title "[compound-engineering] Bug: [简要描述]" \
  --body "[格式化后的Bug报告]"

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/[编号]
标题：[compound-engineering] Bug: [描述]

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

Error Handling

错误处理

  • If 
    gh
    CLI is not installed or not authenticated: prompt the user to install/authenticate first
  • If issue creation fails: display the formatted report so the user can manually create the issue
  • If required information is missing: re-prompt for that specific field
  • 如果
    gh
    CLI未安装或未认证：提示用户先安装/认证
  • 如果Issue创建失败：展示格式化后的报告，以便用户手动创建Issue
  • 如果缺少必填信息：重新提示用户补充该特定字段

Privacy Notice

隐私声明

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