跳到主要内容

报告 Bug

开源中最有价值的角色之一,就是花时间把 bug 报告得清楚明白。

尽管我们尽了最大努力,但永远无法彻底消除 bug。

即使你无法修复底层的代码,但只要把 bug 报告得好,就能让更熟悉代码库的人发现某种规律,或者快速修复它。

以下是几个关键步骤。

这真的是 Bug 吗?

先想想你是想寻求某方面的帮助,还是认为 Nuxt 本身存在 bug。如果是前者,我们很乐意帮忙——但最好的方式是通过寻求帮助,而不是报告 bug。

搜索已有问题

先搜索已存在的问题讨论。如果你发现任何看似相同的 bug,最好在已有帖子上评论,而不是重复创建。

创建一个最小复现

能够可靠地以最小化的方式复现 bug,并且与项目的其余部分隔离开,这一点很重要。这能缩小可能导致问题的范围,让其他人不仅能找到原因,还能测试潜在的解决方案。

从 Nuxt 沙盒开始,添加最少量的代码来复现你遇到的问题。

如果你的 issue 涉及 Vue 或 Vite,请先尝试用 Vue SSR 起始模板复现它。

Nuxt

Nuxt on StackBlitz

Nuxt on CodeSandbox

Vue

Vue SSR on StackBlitz

Vue SSR on CodeSandbox

Vue SSR Template on GitHub

一旦复现了问题,就从你的复现中尽可能多地移除代码(同时仍能复现该 bug)。花时间让复现尽可能最小化,对着手修复问题的人会有巨大的帮助。

推断可能的原因

一个 Nuxt 项目包含许多动态的部分——从Nuxt 模块其他 JavaScript 库。尽量在最相关、最具体的地方报告 bug。那很可能是导致问题的 Nuxt 模块,或者是 Nuxt 所依赖的上游库。