a673e84aaa
## Why? - Update **Docs Request for an Update or Improvement** to **Docs Report**, similar to **Bug Report** - Update template descriptions Closes NEXT-3255
64 lines
3.4 KiB
YAML
64 lines
3.4 KiB
YAML
name: Bug Report for Examples
|
|
description: Create a bug report for Next.js examples.
|
|
labels: ['examples']
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
*Note:* If you leave out sections, the issue might be moved to the ["Help" section](https://github.com/vercel/next.js/discussions/categories/help).
|
|
Thanks for taking the time to file a bug report for [one of the examples](https://github.com/vercel/next.js/tree/canary/examples)! Please fill out this form as completely as possible.
|
|
- type: checkboxes
|
|
attributes:
|
|
label: Verify canary release
|
|
description: 'Please run `npm install next@canary` to try the canary version of Next.js that ships daily. It includes all features and fixes that have not been released to the stable version yet. Some issues may already be fixed in the canary version, so please verify that your issue reproduces before opening a new issue.'
|
|
options:
|
|
- label: I verified that the issue exists in the latest Next.js canary release
|
|
required: true
|
|
- type: textarea
|
|
attributes:
|
|
label: Provide environment information
|
|
description: Please run `next info` in the root directory of your project and paste the results. You might need to use `npx --no-install next info` if next is not in the current PATH.
|
|
render: bash
|
|
validations:
|
|
required: true
|
|
- type: input
|
|
attributes:
|
|
label: Which example does this report relate to?
|
|
description: "See a complete list in the [examples folder](https://github.com/vercel/next.js/tree/canary/examples). For example: `with-styled-components`. Note: Examples not in the examples folder might be maintained by the example's library author. Check out their projects before opening the issue on Next.js"
|
|
validations:
|
|
required: true
|
|
- type: input
|
|
attributes:
|
|
label: What browser are you using? (if relevant)
|
|
description: 'Please specify the exact version. For example: Chrome 100.0.4878.0'
|
|
- type: input
|
|
attributes:
|
|
label: How are you deploying your application? (if relevant)
|
|
description: 'For example: next start, Vercel, Other platform'
|
|
- type: textarea
|
|
attributes:
|
|
label: Describe the Bug
|
|
description: A clear and concise description of what the bug is.
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
attributes:
|
|
label: Expected Behavior
|
|
description: A clear and concise description of what you expected to happen.
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
attributes:
|
|
label: To Reproduce
|
|
description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the relevant example. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
|
|
validations:
|
|
required: true
|
|
- type: markdown
|
|
attributes:
|
|
value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
|
|
- type: markdown
|
|
attributes:
|
|
value: Contributors should be able to follow the steps provided in order to reproduce the bug.
|
|
- type: markdown
|
|
attributes:
|
|
value: Thanks in advance!
|