ab38e2ffd0
- Bump version to 2.28.0 in plugin.json and marketplace.json (CHANGELOG was updated but version numbers were missed) - Fix all repo URLs from kieranklaassen/* to EveryInc/compound-engineering-plugin - Update component counts in docs: 28 agents, 24 commands, 15 skills, 1 MCP Co-Authored-By: Claude <noreply@anthropic.com>
151 lines
3.8 KiB
Markdown
151 lines
3.8 KiB
Markdown
---
|
|
name: report-bug
|
|
description: Report a bug in the compound-engineering plugin
|
|
argument-hint: "[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.
|