Get the FREE Ultimate OpenClaw Setup Guide →

bug-report

npx machina-cli add skill cyberwalk3r/qa-toolkit/bug-report --openclaw
Files (1)
SKILL.md
2.3 KB

Bug Report Generator

Transform QA observations into structured bug reports. Read qa-artifacts/.qa-config.json for project context and bug tracker preference.

Input

Accept plain-language descriptions via $ARGUMENTS. Examples:

  • "The checkout page crashes when I enter a long address"
  • "Users can't upload images larger than 2MB, it just shows a spinner forever"
  • "The search results show deleted items sometimes"

Workflow

  1. Parse the observation — extract what happened, where, and when
  2. Ask clarifying questions if critical info is missing:
    • What were you doing when this happened?
    • What did you expect to happen?
    • Can you reproduce it consistently?
    • What browser/device/environment?
  3. Generate the bug report with all fields populated
  4. Classify severity using these definitions:
    • Blocker: Core functionality unusable, no workaround, blocks release
    • Critical: Major feature broken, workaround exists but is unacceptable
    • Major: Feature partially broken, workaround available
    • Minor: Small defect, edge case, minor inconvenience
    • Cosmetic: Visual-only issue, no functional impact
  5. Suggest duplicate search terms to check for existing reports
  6. Format for target platform — load references/platform-formats.md if needed

Output Structure

## [BUG] <Concise title describing the issue>

**Severity**: Blocker / Critical / Major / Minor / Cosmetic
**Priority**: P0 / P1 / P2 / P3
**Component**: <affected area>
**Environment**: <browser, OS, device, app version>

### Description
<1-2 sentence clear description>

### Steps to Reproduce
1. <step>
2. <step>
3. <step>

### Expected Result
<what should happen>

### Actual Result
<what actually happens>

### Additional Context
- Frequency: Always / Intermittent / Once
- Screenshots/logs: <if provided>
- Related issues: <if known>

### Suggested Search Terms for Duplicates
- <term 1>
- <term 2>

Save

Save to qa-artifacts/bug-reports/bug-YYYY-MM-DD-<brief>.md

Suggested Next Steps

After generating the bug report, suggest:

  • "Create test cases to cover this bug scenario and prevent regression with /qa-toolkit:test-cases."

Source

git clone https://github.com/cyberwalk3r/qa-toolkit/blob/main/skills/bug-report/SKILL.mdView on GitHub

Overview

Bug Report Generator converts plain-language QA notes into standardized bug reports formatted for Jira, GitHub Issues, or Azure DevOps. It reads project context from qa-artifacts/.qa-config.json, asks clarifying questions when details are missing, and classifies severity before formatting for the target platform. The tool also suggests duplicate search terms and adheres to platform-specific report formats.

How This Skill Works

Input: plain-language observation via $ARGUMENTS. The tool parses what happened, where, and when, then asks clarifying questions as needed. It generates a complete report with Description, Steps to Reproduce, Expected vs Actual results, Environment, and Severity, formats it for the chosen platform, and saves it under qa-artifacts/bug-reports.

When to Use It

  • Transform plain-language QA observations into structured bug reports for Jira, GitHub, or Azure DevOps.
  • Quickly classify severity (Blocker to Cosmetic) to aid triage and prioritization.
  • Produce reports that include Description, Steps to Reproduce, Expected/Actual results, and Environment.
  • Search for duplicates by generating suggested search terms before creating a new report.
  • Format reports according to platform-specific requirements by referencing platform formats when needed.

Quick Start

  1. Step 1: Provide a plain-language observation via $ARGUMENTS describing what happened, where, and when.
  2. Step 2: Let the tool read qa-artifacts/.qa-config.json to apply project context and preferred bug tracker format.
  3. Step 3: Review the generated bug report, then save it to qa-artifacts/bug-reports/bug-YYYY-MM-DD-<brief>.md and optionally search for duplicates.

Best Practices

  • Start with a clear, concise plain-language observation that states what happened, where, and when.
  • Always include Steps to Reproduce, Expected Result, and Actual Result to ensure reproducibility.
  • Capture the Environment (browser, OS, device, app version) to aid troubleshooting.
  • Ask clarifying questions early if critical information is missing before generating the report.
  • Verify the final report uses the appropriate platform format and save path (qa-artifacts/bug-reports).

Example Use Cases

  • Example 1: Bug report for checkout crash on long address input, generated for Jira.
  • Example 2: Image upload fails with a perpetual spinner, reported to GitHub Issues.
  • Example 3: Search results intermittently show deleted items, formatted for Azure DevOps.
  • Example 4: UI alignment break on Safari mobile, reported for Jira with environment details.
  • Example 5: Missing translations on checkout page in en-US, created for GitHub Issues.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers