提交优质 Bug 报告¶
开始处理 Bug 可能很困难,尤其是在缺乏上下文的情况下。
本指南旨在提供一系列步骤,以便提供必要的信息来打开一个可操作的 Bug 报告。
**使用描述性的标题**。尽可能避免使用术语和缩写,因为它们会使其他人难以找到现有的 Bug 以及理解它们。
**详细解释问题**并提供重现步骤。尽可能具体,并在报告 Bug 时包含操作系统和版本等信息。
如果可以,**列出可能需要修改的文件和代码行**。理想情况下,提供一个用于开始的补丁。不要犹豫,添加指向 Searchfox 的永久链接,指向文件和代码行。
如果适用,**提供一个测试用例**或文档,可用于测试 Bug 是否已解决。例如,如果 Bug 标题是“HTML 检查器在检查包含一百万个节点的页面时失败”,则应提供一个包含一百万个节点的 HTML 文档,我们可以使用它来测试实现,并确保您看到的与我们看到的是相同的。您可以使用 jsfiddle、codepen 或 jsbin 等服务来共享您的测试用例。其他人使用 GitHub 或他们自己的 Web 服务器。
适合新手贡献者的 Bug¶
如果您希望将 Bug 作为“适合新手贡献者的 Bug”提交,请遵守以下准则
**复杂度** 确保 Bug 不过于复杂。新的贡献者已经在学习 Firefox 代码库和工作流程。过于复杂的 Bug 会让人不知所措。
**标签** 使用 Bugzilla 关键词
good-first-bug
进行适当标记。**语言规范** 在白板部分,使用
[lang=XX]
格式指定 Bug 的主要语言。例如,[lang=C++]
用于 C++ 或[lang=py]
用于 Python。**指导** 通过将自己添加为 Bug 的指导者来承诺指导新的贡献者。如果不再有时间,请保持指导者字段更新,将其设置为为空或找到其他可用的指导者。
**文档** 提供可以帮助贡献者的必要文档的链接。例如,您可以包含
通过遵循这些准则,您将为新的贡献者创造成功的条件,并为他们营造一个友好的环境。
这些适合新手贡献者的 Bug 可以在 https://codetribute.mozilla.org/ 上浏览