Bug 报告生成器
此 Skill 用于生成适用于提交给问题追踪系统(如 GitHub Issues)的标准化 Markdown 格式 Bug 报告。
说明
调用时,请分析当前上下文,包括:
- 用户输入:用户对问题的描述。
- 代码变更:可能引入 Bug 的近期文件修改。
- 错误日志:任何可用的控制台输出、堆栈跟踪或错误消息。
- 环境信息:操作系统、软件版本、依赖项(来自
package.json、Manifest.json等)。
然后,按照以下结构生成 Markdown 文件。
重要: 生成内容后,你 必须 使用 Write 工具将其保存为 Markdown 文件,而不是仅仅在对话中输出。
- 目录检查:在保存前,必须 检查项目根目录下是否存在
BugReports目录。如果不存在,请使用RunCommand(mkdir) 或其他方式创建该目录。 - 文件名格式:
bug_report_<简短描述>.md(例如bug_report_login_failure.md) - 保存路径:
BugReports/目录下 (例如BugReports/bug_report_login_failure.md) - 后续操作:保存文件后,请告知用户文件的绝对路径。
报告模板
# Bug 报告:<简明扼要的标题>
## 问题描述
<清晰简洁地描述 Bug。>
## 环境信息
- **操作系统**:<操作系统>
- **项目/库版本**:<版本>
- **Unity 版本**:<Unity 版本(如果适用)>
- **依赖项**:<与 Bug 相关的关键依赖项>
## 复现步骤
1. <步骤 1>
2. <步骤 2>
3. <步骤 3>
## 预期行为
<描述本应发生的情况。>
## 实际行为
<描述实际发生的情况。>
<在此处包含错误日志或截图描述。>
## 根因分析
<详细的技术解释,说明 Bug 为何发生。>
- **文件**:`<文件路径>`
- **原因**:<解释逻辑错误、边界情况或配置问题。>
## 修复方案
<描述已应用或建议的修复。>
### 代码对比
```<语言>
// 旧代码
<原始代码片段>
// 新代码
<修复后的代码片段>
验证
<验证修复所采取的步骤。>
## 使用示例
**用户:** "我发现 RequestRouter 有个 Bug,参数解析不正确。"
**助手:** (调用 `bug-report`) -> 生成一份报告,分析 `RequestRouter.cs`,识别 Regex 问题,并提出修复方案。