| name | bug-reporter |
| description | A skill to help users report bugs in the servicenow-sdk-go repository. It gathers system information, reproduction steps, formats the report into a GitHub issue template, and offers to submit it via the GitHub CLI. |
🐞 Bug Reporter
This skill assists in creating high-quality bug reports for the servicenow-sdk-go SDK.
Workflow
Manual Reporting
- Gather Context: When a user reports a bug, identify the core issue, expected vs. actual behavior, and steps to reproduce.
- Collect System Info: Run the
scripts/gather_info.sh script to collect OS, Go version, and SDK version information.
- Identify Reproduction Steps: If the user hasn't provided clear steps, ask for them or attempt to derive them from the current session's history.
- Format Report: Use the
references/bug_report_template.md as a template to structure the final bug report.
- Submit to GitHub (Optional): If the GitHub CLI (
gh) is available and authenticated, offer to submit the report automatically. Use the scripts/submit_report.sh script to handle the submission process.
- Present to User: If automatic submission is not possible or desired, provide the completed bug report in a Markdown code block, ready for the user to copy and paste into a new GitHub issue.
Automated Reporting (When an issue is identified)
- Identify Bug: When an issue or bug is identified in the codebase or reported by the user, immediately transition to the reporting phase.
- Generate Report: Automatically gather context (Description, Reproduction Steps, Expected Behavior) and system info by running
scripts/generate_report.sh.
- Propose Submission: Present the generated bug report to the user and offer to submit it to GitHub automatically using
scripts/submit_report.sh.
- Finalize: Once the report is generated or submitted, provide the issue link or the report content to the user.
Bundled Resources
Scripts
scripts/gather_info.sh: Gathers basic system information (OS, Go, SDK version).scripts/generate_report.sh: Generates a formatted bug report from provided inputs.scripts/submit_report.sh: Submits a bug report to GitHub using the gh CLI. Requires a title and a path to a report file.
References
references/bug_report_template.md: The official GitHub issue template for bug reports in this repository.
Triggering Examples
- "I found a bug in the attachment API."
- "Create a bug report for this error."
- "Report this issue on GitHub."
- "Automatically generate a bug report when a bug is identified."
- "Wrap this identified issue into a bug report."
