报告错误

在开源社区中,花时间以有帮助的方式报告错误是一项非常有价值的工作。

无论我们如何努力,都无法完全消除错误。

即使你无法修复底层代码,恰当地报告一个错误也能让对代码库更熟悉的其他人发现模式或快速修复问题。

下面是一些关键步骤。

这真的是一个错误吗?

考虑一下你是在寻求帮助,还是认为 Nuxt 本身存在错误。如果是前者,我们很乐意帮助你——但最好的方式是通过 寻求帮助 而不是报告一个错误。

搜索 Issues

先搜索 开放的 issues讨论。如果你发现任何看起来像相同错误的内容,评论现有的线程比创建重复条目要好得多。

创建最小可复现示例

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

从 Nuxt 沙箱开始,添加复现你所遇到错误所需的 最少 代码。

如果你的问题涉及 Vue 或 Vite,请先尝试使用 Vue SSR 启动模板来复现问题。

Nuxt:

在 StackBlitz 上使用 Nuxt

在 CodeSandbox 上使用 Nuxt

Vue:

StackBlitz 上的 Vue SSR

CodeSandbox 上的 Vue SSR

GitHub 上的 Vue SSR 模板

复现出问题后,尽可能从你的复现示例中移除尽可能多的代码(同时仍能重现该错误)。为使复现示例尽可能最小而投入的时间,对将要修复问题的人会有巨大帮助。

找出可能的原因

对于 Nuxt 项目来说,涉及许多可变的部分——从 Nuxt 模块其他 JavaScript 库。尽量在最相关且最具体的地方报告错误。那很可能是导致问题的 Nuxt 模块,或是 Nuxt 所依赖的上游库。