Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-28 08:32:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve community section for bug report (#979)

Browse Source
This commit is contained in:
Sébastien Chopin 2021-10-13 21:46:37 +02:00 committed by GitHub
parent a413bd1102
commit 39f7b83791
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/content/4.community/1.getting-help.md
View File

@ -22,8 +22,6 @@ And finally, just ask the question! There's no need to [ask permission to ask a
## "Could there be a bug?" ## "Could there be a bug?"
Something isn't working the way that the docs say that it should. You're not sure if it's a bug. You've searched through the open issues and discussions but you can't find anything. Something isn't working the way that the docs say that it should. You're not sure if it's a bug. You've searched through the [open issues](https://github.com/nuxt/framework/issues) and [discussions](https://github.com/nuxt/framework/discussions) but you can't find anything. (if there is a closed issue, please create a new one)
In that case, the best thing to do is to try to reproduce the bug in a minimal way, apart from the rest of your project. This is a great way to solve problems. There's [a Nuxt 3 starter sandbox](https://codesandbox.io/s/github/nuxt/starter/tree/v3) you can fire up in the browser for exactly this purpose. We recommend to take a look at [how to report bugs](/community/reporting-bugs). Nuxt 3 is still in active development, and every issue helps make it better.
Even if you can't create a minimal reproduction, [please do report the bug](/community/reporting-bugs). Nuxt 3 is still in active development, and every issue helps make it better.

12
docs/content/4.community/2.reporting-bugs.md
View File

@ -16,13 +16,19 @@ Search through the [open issues](https://github.com/nuxt/framework/issues) and [
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. 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 Nuxt3 sandbox and add the **minimum** amount of code necessary to reproduce the bug you're experiencing: 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**:
:button-link[Nuxt 3 on StackBlitz]{href=https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz blank} :button-link[Nuxt 3 on StackBlitz]{href=https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz blank}
:button-link[Nuxt 3 on CodeSandBox]{href=https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox blank} :button-link[Nuxt 3 on CodeSandBox]{href=https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox blank}
Once you've reproduced the issue, remove as much code from your reproduction as you can (while still recreating the bug). Time spent making the reproduction as minimal as possible will make a huge difference to whoever sets out to fix the issue. **Nuxt Bridge**:
:button-link[Nuxt Bridge on CodeSandBox]{href=https://codesandbox.io/s/github/nuxt/starter/tree/bridge-codesandbox blank}
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 ## Figure out what the cause might be
With a Nuxt project, there are lots of moving pieces - from [community modules](https://modules.nuxtjs.org/) to [other JavaScript libraries](https://www.npmjs.com/). 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. With a Nuxt project, there are lots of moving pieces - from [nuxt modules](https://nuxtjs.org/modules) to [other JavaScript libraries](https://www.npmjs.com/). 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.