Skip to content

Commit a4c6a31

Browse files
authored
chore(github): add ISSUE_TEMPLATE for bug reports
1 parent e443949 commit a4c6a31

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: "\U0001F41E Bug report"
2+
description: Create a report to help us improve
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
**Before You Start...**
8+
9+
This form is only for submitting bug reports. If you have a usage question
10+
or are unsure if this is really a bug, make sure to:
11+
12+
- Read the [docs](https://vue3-select-component.vercel.app/)
13+
- Ask on [GitHub Discussions](https://github.com/TotomInc/vue3-select-component/discussions)
14+
15+
Also try to search for your issue - it may have already been answered.
16+
However, if you find that an old, closed issue still persists in the latest version,
17+
you should open a new issue using the form below instead of commenting on the old issue.
18+
- type: input
19+
id: version
20+
attributes:
21+
label: Vue3-Select-Component version
22+
validations:
23+
required: true
24+
- type: input
25+
id: reproduction-link
26+
attributes:
27+
label: Link to minimal reproduction
28+
description: |
29+
The easiest way to provide a reproduction is by showing the bug on the Vue3-Select-Component playground, go the the [docs](https://vue3-select-component.vercel.app/) and click on "Playground" on the header links.
30+
If it cannot be reproduced in the playground and requires a proper build setup, try [StackBlitz](https://vite.new/vue).
31+
If neither of these are suitable, you can always provide a GitHub repository.
32+
33+
The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed to show the bug.
34+
35+
Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided.
36+
placeholder: Reproduction Link
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: steps-to-reproduce
41+
attributes:
42+
label: Steps to reproduce
43+
description: |
44+
What do we need to do after opening your repro in order to make the bug happen? Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code.
45+
placeholder: Steps to reproduce
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: What is expected?
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: actually-happening
56+
attributes:
57+
label: What is actually happening?
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: additional-comments
62+
attributes:
63+
label: Any additional comments?
64+
description: e.g. some background/context of how you ran into this bug.

0 commit comments

Comments
 (0)