撰写有效的 Bug 报告

:bookmark: 本指南旨在指导您在 Discourse 中撰写有效的 Bug 报告,以最大程度地提高 Bug 被修复的机会。

:person_raising_hand: 所需用户级别:任何人都可以报告 Bug

撰写一份好的 Bug 报告对于帮助 Discourse 团队高效修复问题至关重要。本指南将引导您完成步骤和最佳实践,以确保您的 Bug 报告清晰、简洁且可操作。

摘要

在本篇文档中,我们将介绍:

  • 提供可重现步骤和具体细节的重要性
  • 如何描述问题和预期行为
  • 在不同平台上报告的最佳实践
  • 在报告中保持适当的语气
  • 常见陷阱和解决方案

撰写有效 Bug 报告的步骤

优先级/严重性

确定修复 Bug 的紧迫性。虽然每个人都希望他们的问题能尽快得到解决,但请将最高优先级留给严重影响功能的关键问题。

平台

始终指定观察到 Bug 的环境。这包括:

  • 设备类型(桌面、移动设备、触摸屏、平板电脑)
  • 操作系统及其版本
  • 网络浏览器及其版本

如果可能,请在多个平台上重现 Bug,以确认其存在。

描述

保持简洁。简单地描述问题,不要添加不必要的细节。如果不同的问题可以单独报告,请将它们分开。清晰的描述格式包括:

实际结果: 发生了什么?
预期结果: 应该发生什么?

避免假设读者已经知道某些信息。明确说明应该看到或发生的内容。

可重现步骤

确保 Bug 可以一致地重现。从 Discourse 的主屏幕开始,编写分步说明。如果 Bug 随机出现,请指定它发生的频率(例如,10 次尝试中有 1 次)。对于与 UI/UX 相关的 Bug,请添加屏幕截图或视频以供清晰说明。

语气

保持尊重和礼貌的语气。避免使用 Bug 报告来表达沮丧。任何有毒的语言或行为都可能导致您的报告被延迟或忽略。

模板

使用此模板快速开始一个新的 Bug 报告主题:

优先级/严重性:

平台:

描述:

可重现步骤:

最佳实践

  1. 在安全模式下重现:报告之前,如果您怀疑自定义设置可能导致问题,请尝试在 Discourse 的安全模式下重现该问题。
  2. 质疑假设:Bug 报告通常源于错误的假设。即使在您的报告中,也要质疑并澄清您可能有的任何假设。
  3. 提供详细信息:对于难以捉摸或罕见的 Bug,请提供尽可能多的细节。包括您认为可能相关的任何内容,例如错误消息或日志文件。

常见问题和解决方案

问题: 无法一致地重现 Bug。
解决方案: 记录 Bug 出现时的环境和条件。注意任何模式或共性。

问题: Bug 报告没有得到回复。
解决方案: 确保您的报告详细但简洁,并且语气得体。

常见问题解答

问:如果我没有时间撰写详细的报告怎么办?
答:提供您拥有的信息并打开报告仍然有帮助。请注明您稍后会更新更多详细信息。

问:我应该在哪里发布我的 Bug 报告?
答:使用正确的类别——Bug 报告应发布在 bug 类别中。

附加资源

42 个赞