Skip to content

Commit b8a0e37

Browse files
committed
chore: add ISSUE_TEMPLATE
1 parent 72028fb commit b8a0e37

File tree

3 files changed

+116
-0
lines changed

3 files changed

+116
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
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'm using [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc). (`*.json` file linting does not work with the parser alone. You should also use eslint-plugin-jsonc with it.)
16+
- label: I'm sure the problem is a parser problem. (If you are not sure, search for the issue in [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) repo and open the issue in [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) repo if there is no solution.
17+
required: true
18+
- label: I have tried restarting my IDE and the issue persists.
19+
required: true
20+
- label: I have updated to the latest version of the packages.
21+
required: true
22+
- type: input
23+
id: eslint-version
24+
attributes:
25+
label: What version of ESLint are you using?
26+
placeholder: 0.0.0
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: eslint-plugin-jsonc-version
31+
attributes:
32+
label: What version of `eslint-plugin-jsonc` and ` jsonc-eslint-parser` are you using?
33+
value: |
34+
35+
- [email protected] (if you have installed.)
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: What did you do?
41+
description: |
42+
Please include a *minimal* reproduction case.
43+
value: |
44+
<details>
45+
<summary>Configuration</summary>
46+
47+
```
48+
<!-- Paste your configuration here -->
49+
```
50+
</details>
51+
52+
```json
53+
<!-- Paste your code here -->
54+
```
55+
validations:
56+
required: true
57+
- type: textarea
58+
attributes:
59+
label: What did you expect to happen?
60+
description: |
61+
You can use Markdown in this field.
62+
validations:
63+
required: true
64+
- type: textarea
65+
attributes:
66+
label: What actually happened?
67+
description: |
68+
Please copy-paste the actual ESLint output. You can use Markdown in this field.
69+
validations:
70+
required: true
71+
- type: textarea
72+
id: bug-reproduction
73+
attributes:
74+
label: Link to **GitHub Repo** with Minimal Reproducible Example
75+
description: |
76+
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.
77+
[Why Reproductions are Required](https://antfu.me/posts/why-reproductions-are-required)
78+
79+
Be sure to share the repo on GitHub. GitHub's repo is ready to debug using Codespace.
80+
Please DON'T USE non-GitHub repos such as GitLab as repro.
81+
It takes me a long time to prepare my local PC for debugging.
82+
Please DON'T USE stackblitz as a repro.
83+
We can't debug eslint with stackblitz.
84+
placeholder: |
85+
https://github.com/[your]/[repo]
86+
validations:
87+
required: true
88+
- type: textarea
89+
attributes:
90+
label: Additional comments
+13
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.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Other
2+
description: An issue that doesn't fit into the other categories.
3+
labels: []
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Description
9+
description: |
10+
A clear and concise description.
11+
Also give a few code examples.
12+
validations:
13+
required: true

0 commit comments

Comments
 (0)