home / skills / everyinc / compound-engineering-plugin / report-bug

report-bug skill

/plugins/compound-engineering/skills/report-bug

This skill helps users report bugs for the compound-engineering plugin by collecting details and creating a GitHub issue.

npx playbooks add skill everyinc/compound-engineering-plugin --skill report-bug

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
3.9 KB
---
name: report-bug
description: Report a bug in the compound-engineering plugin
argument-hint: "[optional: brief description of the bug]"
disable-model-invocation: true
---

# Report a Compounding Engineering Plugin Bug

Report bugs encountered while using the compound-engineering plugin. This command gathers structured information and creates a GitHub issue for the maintainer.

## Step 1: Gather Bug Information

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

## Step 2: Collect Environment Information

Automatically gather:
```bash
# 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
```

## Step 3: Format the Bug Report

Create a well-structured bug report with:

```markdown
## 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

```
[Any error output]
```

## Additional Context

[Any other relevant information]

---
*Reported via `/report-bug` command*
```

## Step 4: Create 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]"
```

## Step 5: Confirm Submission

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

## 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.
```

## 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

## 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.

Overview

This skill helps you report bugs in the compound-engineering plugin by collecting structured details and creating a GitHub issue for the maintainer. It automates environment gathering, formats a clear bug report, and optionally files the issue via the GitHub CLI.

How this skill works

I ask a short series of targeted questions to capture the bug category, affected component, actual vs expected behavior, reproduction steps, and any error messages. I automatically collect local environment data (plugin version, Claude Code version, and OS) and assemble a well-structured report. If possible, I use the GitHub CLI to create the issue and return the issue URL; if not, I present the formatted report for manual filing.

When to use it

  • You encountered unexpected behavior in an agent, command, or skill from the compound-engineering plugin.
  • A command or MCP server connection is failing and you want to report it with reproduction steps.
  • Installation problems or runtime errors occur and you want the maintainer to triage them.
  • You want to report reproducible bugs with full environment context for faster investigation.
  • You prefer an automated, consistent GitHub issue format instead of composing the report manually.

Best practices

  • Provide concise, concrete reproduction steps so maintainers can reproduce the issue reliably.
  • Paste exact error messages and any relevant logs rather than paraphrasing them.
  • Specify the exact agent, command, skill name, or MCP server component involved.
  • Run the automatic environment checks and include their output to speed diagnosis.
  • If gh CLI is not authenticated, authenticate before filing or be prepared to copy the formatted report into GitHub manually.

Example use cases

  • An agent stops responding after a specific command and you want to supply reproduction steps and errors.
  • A skill returns incorrect results intermittently and you need to show expected vs actual behavior.
  • Installation fails with a permission or dependency error and you want the plugin version and OS included.
  • The MCP server rejects connections and you want to report the server name and error output.
  • You want to create a clean, consistent GitHub issue for a maintainer to triage quickly.

FAQ

What if the GitHub CLI (gh) is not authenticated?

I will prompt you to run gh auth login. If you prefer, I will provide the formatted report so you can create the issue manually.

What environment info is collected automatically?

I collect the installed plugin entry, the Claude Code CLI version (if available), and basic OS information (uname output). No personal data or credentials are collected.