Skip to content

Commit caec25b

Browse files
committed
chore: add issue templates with reproduction link (closes #269)
Add GitHub issue forms enforcing minimal info: - bug_report.yml: required module/Nuxt/Vuetify versions, required reproduction link, steps, expected/actual, validations checklist - feature_request.yml: problem, proposed solution, alternatives - config.yml: disable blank issues; redirect usage questions to the docs and the Vuetify Discord (Discussions are disabled)
1 parent 9b8bd74 commit caec25b

3 files changed

Lines changed: 156 additions & 0 deletions

File tree

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
name: 🐞 Bug report
2+
description: Report a reproducible bug in vuetify-nuxt-module
3+
labels: [bug, needs reproduction]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to file a bug report! 🙏
9+
10+
Before submitting, please:
11+
- Search [existing issues](https://github.com/vuetifyjs/nuxt-module/issues) to avoid duplicates.
12+
- Read the [documentation](https://nuxt.vuetifyjs.com/).
13+
- Provide a **minimal reproduction** — issues without one are likely to be closed.
14+
15+
- type: input
16+
id: module-version
17+
attributes:
18+
label: vuetify-nuxt-module version
19+
placeholder: e.g. 1.0.0-beta.9
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: nuxt-version
25+
attributes:
26+
label: Nuxt version
27+
placeholder: e.g. 4.3.1
28+
validations:
29+
required: true
30+
31+
- type: input
32+
id: vuetify-version
33+
attributes:
34+
label: Vuetify version
35+
placeholder: e.g. 3.10.0
36+
validations:
37+
required: true
38+
39+
- type: input
40+
id: reproduction
41+
attributes:
42+
label: Reproduction
43+
description: |
44+
A link to a **minimal** reproduction (StackBlitz, a public GitHub repo, etc.).
45+
Reports without a reproduction are likely to be closed.
46+
placeholder: https://stackblitz.com/edit/...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: steps
52+
attributes:
53+
label: Steps to reproduce
54+
description: How can we trigger the bug in your reproduction?
55+
placeholder: |
56+
1. Go to '...'
57+
2. Click on '...'
58+
3. See error
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: expected
64+
attributes:
65+
label: Expected behavior
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: actual
71+
attributes:
72+
label: Actual behavior
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: system-info
78+
attributes:
79+
label: System info
80+
description: Output of `npx nuxi info` (or `npx envinfo --system --binaries --browsers`).
81+
render: shell
82+
83+
- type: textarea
84+
id: additional
85+
attributes:
86+
label: Additional context
87+
description: Logs, screenshots, or anything else that might help.
88+
89+
- type: checkboxes
90+
id: checklist
91+
attributes:
92+
label: Validations
93+
options:
94+
- label: I have searched the existing issues and this is not a duplicate.
95+
required: true
96+
- label: I have provided a minimal reproduction.
97+
required: true
98+
- label: I have read the documentation.
99+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://nuxt.vuetifyjs.com/
5+
about: Check the docs first — most "how do I…" questions are answered there.
6+
- name: 💬 Questions & Help
7+
url: https://discord.vuetifyjs.com/
8+
about: For usage questions and general help, ask in the Vuetify Discord. The issue tracker is for bugs and feature requests only.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea or enhancement for vuetify-nuxt-module
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping improve vuetify-nuxt-module! 🙏
9+
10+
Before submitting, please search [existing issues](https://github.com/vuetifyjs/nuxt-module/issues)
11+
to avoid duplicates.
12+
13+
- type: textarea
14+
id: problem
15+
attributes:
16+
label: Problem / motivation
17+
description: What problem are you trying to solve? Why is the current behavior not enough?
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: solution
23+
attributes:
24+
label: Proposed solution
25+
description: Describe the feature or change you'd like to see.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives considered
33+
description: Any alternative solutions or workarounds you've tried.
34+
35+
- type: textarea
36+
id: additional
37+
attributes:
38+
label: Additional context
39+
description: Links, references, or anything else that helps explain the request.
40+
41+
- type: checkboxes
42+
id: checklist
43+
attributes:
44+
label: Validations
45+
options:
46+
- label: I have searched the existing issues and this is not a duplicate.
47+
required: true
48+
- label: I have read the documentation.
49+
required: true

0 commit comments

Comments
 (0)