Reporting Bugs

Try as we might, we never completely eliminate bugs. One of the most valuable roles in open source is taking the time to report bugs helpfully. Even if you can't fix the underlying code, reporting a bug well can enable someone else with a bit more familiarity with the codebase to spot a pattern or make a quick fix.

Here are a few key steps.

Is it really a bug?

Consider if you're looking to get help with something, or whether you think there's a bug with Nuxt itself. If it's the former, we'd love to help you - but the best way to do that is through asking for help rather than reporting a bug.

Search the issues

Search through the open issues and discussions first. If you find anything that seems like the same bug, it's much better to comment on an existing thread than create a duplicate.

Create a minimal reproduction

It's important to be able to reproduce the bug reliably - in a minimal way and apart from the rest of your project. This narrows down what could be causing the issue and makes it possible for someone not only to find the cause, but also to test a potential solution.

Start with the Nuxt 3 or Nuxt Bridge sandbox and add the minimum amount of code necessary to reproduce the bug you're experiencing.

Nuxt 3:

Nuxt 3 on StackBlitz Nuxt 3 on CodeSandBox

Nuxt Bridge:

Nuxt Bridge on CodeSandBox

Once you've reproduced the issue, remove as much code from your reproduction as you can (while still recreating the bug). The time spent making the reproduction as minimal as possible will make a huge difference to whoever sets out to fix the issue.

Figure out what the cause might be

With a Nuxt project, there are lots of moving pieces - from nuxt modules to other JavaScript libraries . Try to report the bug at the most relevant and specific place. That will likely be the Nuxt module causing an issue, or the upstream library that Nuxt is depending on.

Edit this page on GitHub Updated at Mon, Dec 6, 2021