home / skills / ratacat / claude-skills / report-bug

report-bug skill

/skills/report-bug

This skill helps you report bugs for the compound-engineering plugin by gathering details and creating a GitHub issue for faster resolution.

npx playbooks add skill ratacat/claude-skills --skill report-bug

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

Files (1)
SKILL.md
3.8 KB
---
name: report-bug
description: Report a bug in the compound-engineering plugin
---

## Arguments
[optional: brief description of the bug]

# 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 reports bugs for the compound-engineering plugin by collecting structured details and creating a GitHub issue for the maintainer. It guides the user through a short questionnaire, gathers environment data automatically, formats a clear bug report, and attempts to open an issue via the GitHub CLI.

How this skill works

The skill asks a series of focused questions to capture category, affected component, actual vs expected behavior, reproduction steps, and any error output. It runs a few simple local commands to capture plugin, CLI, and OS information, formats everything into a concise report, and then uses the GitHub CLI to create an issue in the compound-engineering plugin repository. If issue creation fails, it provides the formatted report for manual submission.

When to use it

  • You encounter an agent, command, or skill in the compound-engineering plugin that behaves incorrectly.
  • Installation or MCP server issues related to the compound-engineering plugin.
  • You can reproduce a bug and want to provide clear, actionable steps.
  • You want to create a well-structured GitHub issue quickly with environment context.
  • You prefer automated collection of plugin and OS details to speed triage.

Best practices

  • Provide concise, focused descriptions of actual vs expected behavior.
  • List minimal reproducible steps so maintainers can recreate the issue quickly.
  • Include full error messages and any stack traces you saw.
  • Run the tool from the environment where the issue occurred so plugin/OS info is accurate.
  • If GitHub CLI authentication fails, copy the formatted report and create the issue manually.

Example use cases

  • Agent not responding to invoked commands and returning unexpected output.
  • A skill command produces an error stack trace during execution.
  • Installation fails with dependency or permission errors on a specific OS.
  • MCP server reports connection or authentication failures affecting plugin behavior.
  • You want to report a consistent, reproducible bug with clear reproduction steps.

FAQ

What if I don’t have the GitHub CLI configured?

If gh is not authenticated the skill will prompt you to run gh auth login. You can also copy the formatted report and create the issue manually via the GitHub web UI.

What environment data is collected?

The skill gathers plugin version from installed_plugins.json, the Claude CLI version (claude --version), and basic OS info (uname -a). It does not collect personal data, API keys, or private code.