报告 Bug

在开源项目中,最有价值的角色之一是花时间以有帮助的方式报告 bug。

尽管我们尽力而为,我们永远无法完全消除 bug。

即使您无法修复底层的代码,良好地报告一个 bug 也能让对代码库更熟悉的人发现模式或进行快速修复。

以下是一些关键步骤。

这真的是一个 Bug 吗?

请考虑您是需要帮助解决某个问题,还是认为 Nuxt 本身存在 bug。如果是前者,我们很乐意帮助您——但最好的方式是通过寻求帮助,而不是报告 bug。

搜索已有的问题

首先搜索开放的问题讨论。如果您发现了似乎是相同 bug 的内容,最好在现有线程中评论,而不是创建重复的问题。

创建一个最小重现

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

从 Nuxt 沙箱开始,添加重现您遇到的 bug 所需的最少代码。

如果您的问题与 Vue 或 Vite 相关,请先尝试使用 Vue SSR 启动模板进行重现。

Nuxt:

在 StackBlitz 上运行 Nuxt

在 CodeSandbox 上运行 Nuxt

Vue:

在 StackBlitz 上运行 Vue SSR

在 CodeSandbox 上运行 Vue SSR

在 GitHub 上的 Vue SSR 模板

一旦您重现了问题,尽可能从您的重现中删除代码(同时仍能重现 bug)。花时间让重现尽可能精简,将为修复问题的人带来巨大的帮助。

找出可能的根本原因

在一个 Nuxt 项目中,有很多活动部件——从 Nuxt 模块其他 JavaScript 库。尽量在最相关且具体的地方报告 bug。这可能是导致问题的 Nuxt 模块,或者 Nuxt 所依赖的上游库。