如何向 BreezeWiki 报告 bug
BreezeWiki 文档里专门设有 Reporting Bugs(报告问题) 章节,并分成两部分:Actually sending a report(实际提交报告) 和 Other communication channels(其他沟通渠道)。也就是说,报告问题有正式入口,也有备用渠道;如果你在自动重定向、镜像访问或自建实例中遇到异常,按这两条路径走即可。
先确认问题类型
报告前先判断问题属于哪一类,能帮你选对渠道、也方便维护者定位:
| 问题类型 | 典型表现 | 建议去向 |
|---|---|---|
| 页面渲染异常 | 页面结构错乱、内容缺失、样式异常 | 提交 bug 报告 |
| 自动重定向失效 | 浏览器扩展或重定向规则没有生效 | 先查 Automatic Redirection 章节,再报告 |
| 镜像不可用 | 某个镜像打不开或返回错误 | 提交报告,并注明具体镜像地址 |
| 自建实例问题 | 运行、配置、Docker 启动失败 | 先对照 Running / Configuration 章节自查 |
| 开发相关问题 | 源码、测试、Fandom 端点、HTML 转换 | 参考 Developing BreezeWiki 章节 |
提交报告的实际步骤
文档把“真正把报告发出去”单独列为一节,说明这一步是重点。可以按下面的顺序操作:
- 先复现问题:确认问题能稳定出现,记录触发条件(访问的页面、使用的镜像、浏览器或扩展版本)。
- 对照文档自查:如果是重定向问题,先看 Automatic Redirection;如果是自建实例,先看 Running 和 Configuration,排除配置遗漏。
- 整理最小信息:包括问题现象、复现步骤、预期结果、实际结果,以及你使用的入口(官方站、镜像还是本地实例)。
- 通过正式渠道提交:按 Reporting Bugs 章节给出的方式发送报告。
- 等待或跟进:如果长时间没有回应,再考虑使用其他沟通渠道。
其他沟通渠道
文档在“Actually sending a report”之外,还单列了 Other communication channels。这意味着正式提交之外还有补充联系方式,适合以下情况:
- 不确定问题是否算 bug,想先问一下;
- 报告已经提交,但需要补充信息或跟进;
- 想反馈镜像可用性、重定向规则等偏使用层面的问题。
具体渠道名称和入口以文档页面上的 Reporting Bugs 章节为准,建议直接打开该章节查看最新列表。
常见卡点
- 只描述现象,没有复现步骤:维护者难以定位,报告容易被搁置。
- 把配置问题当成 bug:自建实例启动失败,很多时候是 Required options 没填或环境变量写错,先查 Configuration 更高效。
- 重定向没生效就报 bug:先确认浏览器扩展(如 Indie Wiki Buddy、Redirector、Violentmonkey、LibRedirect)是否安装并启用,再看 Automatic Redirection 章节的对应说明。
- 镜像问题没写清是哪一个:BreezeWiki 有官方站、多个 Mirrors 和 Onion Mirrors,报告时注明具体地址能省一轮沟通。
一句话结论
遇到 BreezeWiki 的问题,先按类型自查文档对应章节,再通过 Reporting Bugs 里的正式方式提交;正式渠道之外,还可以使用 Other communication channels 补充沟通。