Skip to content

Commit 6692102

Browse files
farnabazfarnabaz
committed
chore: update issue templates
1 parent 99f5ac9 commit 6692102

File tree

2 files changed

+98
-12
lines changed

2 files changed

+98
-12
lines changed

‎.github/ISSUE_TEMPLATE/bug-report-v2.yml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: "🐛 Bug report (v2)"
2+
description: Report a bug to help us improve the module (v2 only).
3+
labels: ["pending triage", "v2"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please carefully read the contribution docs before creating a bug report
9+
👉 https://nuxt.com/docs/community/reporting-bugs
10+
Please use one of the templates below to create a minimal reproduction:
11+
👉 https://stackblitz.com/github/nuxt/starter/tree/content for general issues
12+
- type: markdown
13+
attributes:
14+
value: |
15+
Before reporting a bug, please make sure that you have read through our [v2 documentation](https://v2.content.nuxt.com/).
16+
- type: textarea
17+
id: env
18+
attributes:
19+
label: Environment
20+
description: You can use `npx nuxi info` to fill this section
21+
placeholder: |
22+
- Operating System: `Darwin`
23+
- Node Version: `v18.16.0`
24+
- Nuxt Version: `3.7.3`
25+
- CLI Version: `3.8.4`
26+
- Nitro Version: `2.6.3`
27+
- Package Manager: `pnpm@8.7.4`
28+
- Builder: `-`
29+
- User Config: `-`
30+
- Runtime Modules: `-`
31+
- Build Modules: `-`
32+
validations:
33+
required: true
34+
- type: input
35+
id: version
36+
attributes:
37+
label: Version
38+
placeholder: v2
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: reproduction
43+
attributes:
44+
label: Reproduction
45+
description: Please provide a reproduction link. A minimal [reproduction is required](https://antfu.me/posts/why-reproductions-are-required) unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "needs reproduction" label. If no reproduction is provided we might close it.
46+
placeholder: https://github.com/my/reproduction
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: description
51+
attributes:
52+
label: Description
53+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description.
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: additonal
58+
attributes:
59+
label: Additional context
60+
description: If applicable, add any other context or screenshots here.
61+
- type: textarea
62+
id: logs
63+
attributes:
64+
label: Logs
65+
description: |
66+
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
67+
render: shell-script

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: "\U0001F41E Bug Report"
2-
description: Create a report to help us improve Nuxt
2+
description: Create a report to help us improve Nuxt Content
33
labels: ["pending triage"]
44
body:
55
- type: markdown
@@ -9,40 +9,59 @@ body:
99
👉 https://nuxt.com/docs/community/reporting-bugs
1010
Please use one of the templates below to create a minimal reproduction:
1111
👉 https://stackblitz.com/github/nuxt/starter/tree/content for general issues
12-
👉 https://stackblitz.com/github/nuxt/starter/tree/doc-driven for document-driven mode issues
12+
- type: markdown
13+
attributes:
14+
value: |
15+
Before reporting a bug, please make sure that you have read through our [documentation](https://content.nuxt.com/).
1316
- type: textarea
14-
id: bug-env
17+
id: env
1518
attributes:
1619
label: Environment
1720
description: You can use `npx nuxi info` to fill this section
18-
placeholder: Environment
21+
placeholder: |
22+
- Operating System: `Darwin`
23+
- Node Version: `v18.16.0`
24+
- Nuxt Version: `3.7.3`
25+
- CLI Version: `3.8.4`
26+
- Nitro Version: `2.6.3`
27+
- Package Manager: `pnpm@8.7.4`
28+
- Builder: `-`
29+
- User Config: `-`
30+
- Runtime Modules: `-`
31+
- Build Modules: `-`
32+
validations:
33+
required: true
34+
- type: input
35+
id: version
36+
attributes:
37+
label: Version
38+
placeholder: v2
1939
validations:
2040
required: true
2141
- type: textarea
2242
id: reproduction
2343
attributes:
2444
label: Reproduction
25-
description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://nuxt.com/docs/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it.
26-
placeholder: Reproduction
45+
description: Please provide a reproduction link. A minimal [reproduction is required](https://antfu.me/posts/why-reproductions-are-required) unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "needs reproduction" label. If no reproduction is provided we might close it.
46+
placeholder: https://github.com/my/reproduction
2747
validations:
2848
required: true
2949
- type: textarea
30-
id: bug-description
50+
id: description
3151
attributes:
32-
label: Describe the bug
33-
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
34-
placeholder: Bug description
52+
label: Description
53+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description.
3554
validations:
3655
required: true
3756
- type: textarea
3857
id: additonal
3958
attributes:
4059
label: Additional context
41-
description: If applicable, add any other context about the problem here.
60+
description: If applicable, add any other context or screenshots here.
4261
- type: textarea
4362
id: logs
4463
attributes:
4564
label: Logs
4665
description: |
4766
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
48-
render: Shell
67+
render: shell-script

0 commit comments

Comments
 (0)