Skip to content

Commit e0ac8a2

Browse files
authored
Add issue template (#175)
1 parent 7109e7d commit e0ac8a2

File tree

4 files changed

+145
-0
lines changed

4 files changed

+145
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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: I have tried restarting my IDE and the issue persists.
16+
required: true
17+
- label: I have updated to the latest version of the packages.
18+
required: true
19+
- type: input
20+
id: eslint-version
21+
attributes:
22+
label: What version of ESLint are you using?
23+
placeholder: 0.0.0
24+
validations:
25+
required: true
26+
- type: input
27+
id: eslint-plugin-svelte-version
28+
attributes:
29+
label: What version of `eslint-plugin-svelte` are you using?
30+
placeholder: 0.0.0
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: What did you do?
36+
description: |
37+
Please include a *minimal* reproduction case.
38+
value: |
39+
<details>
40+
<summary>Configuration</summary>
41+
42+
```
43+
<!-- Paste your configuration here -->
44+
```
45+
</details>
46+
47+
```svelte
48+
<!-- Paste your code here -->
49+
```
50+
validations:
51+
required: true
52+
- type: textarea
53+
attributes:
54+
label: What did you expect to happen?
55+
description: |
56+
You can use Markdown in this field.
57+
validations:
58+
required: true
59+
- type: textarea
60+
attributes:
61+
label: What actually happened?
62+
description: |
63+
Please copy-paste the actual ESLint output. You can use Markdown in this field.
64+
validations:
65+
required: true
66+
- type: textarea
67+
id: bug-reproduction
68+
attributes:
69+
label: Link to Minimal Reproducible Example
70+
description: |
71+
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.
72+
[Why Reproductions are Required](https://antfu.me/posts/why-reproductions-are-required)
73+
placeholder: |
74+
https://github.com/[your]/[repo]
75+
or
76+
https://ota-meshi.github.io/eslint-plugin-svelte/playground/#[hash]
77+
validations:
78+
required: true
79+
- type: textarea
80+
attributes:
81+
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
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: New rule request
2+
description: Propose a new rule to be added.
3+
labels: [enhancement, new rule]
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Motivation
9+
description: |
10+
A clear and concise description of the problem the new rule is supposed to solve.
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Description
16+
description: |
17+
A clear and concise description of the new rule.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Examples
23+
description: |
24+
Add some examples of svelte that the rule does and does not report.
25+
value: |
26+
```svelte
27+
<script>
28+
<script>
29+
30+
<!-- ✓ GOOD -->
31+
<Foo />
32+
<Foo />
33+
<Foo />
34+
35+
<!-- ✗ BAD -->
36+
<Foo />
37+
<Foo />
38+
<Foo />
39+
```
40+
validations:
41+
required: true
42+
- type: textarea
43+
attributes:
44+
label: Additional comments

.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)