Skip to content

Commit 256940e

Browse files
authored
Add issue template (#184)
1 parent f3718d7 commit 256940e

File tree

3 files changed

+106
-0
lines changed

3 files changed

+106
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Bug report
2+
description: Create a report to help us improve.
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: checkboxes
10+
id: sanity-checks
11+
attributes:
12+
label: Before You File a Bug Report Please Confirm You Have Done The Following...
13+
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
14+
options:
15+
- label: |
16+
I'm using [eslint-plugin-svelte](https://github.com/ota-meshi/eslint-plugin-svelte).
17+
(`*.svelte` file linting does not work with the parser alone. You should also use eslint-plugin-svelte with it.)
18+
- label: I'm sure the problem is a parser problem. (If you are not sure, search for the issue in [eslint-plugin-svelte](https://github.com/ota-meshi/eslint-plugin-svelte) repo and open the issue in [eslint-plugin-svelte](https://github.com/ota-meshi/eslint-plugin-svelte) repo if there is no solution.
19+
required: true
20+
- label: I have tried restarting my IDE and the issue persists.
21+
required: true
22+
- label: I have updated to the latest version of the packages.
23+
required: true
24+
- type: input
25+
id: eslint-version
26+
attributes:
27+
label: What version of ESLint are you using?
28+
placeholder: 0.0.0
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: eslint-plugin-svelte-version
33+
attributes:
34+
label: What version of `eslint-plugin-svelte` and ` svelte-eslint-parser` are you using?
35+
value: |
36+
37+
38+
validations:
39+
required: true
40+
- type: textarea
41+
attributes:
42+
label: What did you do?
43+
description: |
44+
Please include a *minimal* reproduction case.
45+
value: |
46+
<details>
47+
<summary>Configuration</summary>
48+
49+
```
50+
<!-- Paste your configuration here -->
51+
```
52+
</details>
53+
54+
```svelte
55+
<!-- Paste your code here -->
56+
```
57+
validations:
58+
required: true
59+
- type: textarea
60+
attributes:
61+
label: What did you expect to happen?
62+
description: |
63+
You can use Markdown in this field.
64+
validations:
65+
required: true
66+
- type: textarea
67+
attributes:
68+
label: What actually happened?
69+
description: |
70+
Please copy-paste the actual ESLint output. You can use Markdown in this field.
71+
validations:
72+
required: true
73+
- type: textarea
74+
id: bug-reproduction
75+
attributes:
76+
label: Link to Minimal Reproducible Example
77+
description: |
78+
Create a minimal reproduction of the problem. **A minimal reproduction is required** so that others can help debug your issue. If a report is vague (e.g. just a generic error message) and has no reproduction, it may be closed.
79+
[Why Reproductions are Required](https://antfu.me/posts/why-reproductions-are-required)
80+
placeholder: |
81+
https://github.com/[your]/[repo]
82+
validations:
83+
required: true
84+
- type: textarea
85+
attributes:
86+
label: Additional comments
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Feature request
2+
description: Suggest a new feature.
3+
labels: [enhancement]
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Description
9+
description: |
10+
A clear and concise description of the new feature.
11+
Also give a few code examples.
12+
validations:
13+
required: true

.github/ISSUE_TEMPLATE/other.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Other
3+
about: An issue that doesn't fit into the other categories.
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---

0 commit comments

Comments
 (0)