Skip to content

Commit 023b740

Browse files
snitin315nzakas
snitin315
and
nzakas
authored
chore: add issue templates (#614)
* chore: add issue templates * Update .github/ISSUE_TEMPLATE/docs.yml Co-authored-by: Nicholas C. Zakas <[email protected]> --------- Co-authored-by: Nicholas C. Zakas <[email protected]>
1 parent 6f4d325 commit 023b740

File tree

4 files changed

+134
-0
lines changed

4 files changed

+134
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: "\U0001F41E Report a problem"
2+
description: "Report a problem with ESLint JS language tools"
3+
title: "Bug: (fill in)"
4+
labels:
5+
- bug
6+
- "repro:needed"
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Which packages are affected?
11+
options:
12+
- label: "`espree`"
13+
required: false
14+
- type: textarea
15+
attributes:
16+
label: Environment
17+
description: |
18+
Please provide the following information:
19+
value: |
20+
Node version:
21+
npm version:
22+
ESLint version:
23+
Operating System:
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: What did you do?
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: What did you expect to happen?
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: What actually happened?
39+
validations:
40+
required: true
41+
- type: input
42+
attributes:
43+
label: Link to Minimal Reproducible Example
44+
description: "Link to a [StackBlitz](https://stackblitz.com) or GitHub repo with 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 auto-closed."
45+
placeholder: "https://stackblitz.com/abcd1234"
46+
validations:
47+
required: true
48+
- type: checkboxes
49+
attributes:
50+
label: Participation
51+
options:
52+
- label: I am willing to submit a pull request for this issue.
53+
required: false
54+
- type: textarea
55+
attributes:
56+
label: Additional comments
57+
description: Is there anything else you'd like to mention?

‎.github/ISSUE_TEMPLATE/change.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "\U0001F680 Request a change"
2+
description: "Request a new feature or change to an existing feature"
3+
title: "Change Request: (fill in)"
4+
labels:
5+
- enhancement
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Which packages would you like to change?
10+
options:
11+
- label: "`espree`"
12+
required: false
13+
- type: textarea
14+
attributes:
15+
label: What problem do you want to solve?
16+
description: |
17+
Please explain your use case in as much detail as possible without referring to a specific solution.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: What do you think is the correct solution?
23+
description: |
24+
Please explain what you'd like to change to address the problem.
25+
validations:
26+
required: true
27+
- type: checkboxes
28+
attributes:
29+
label: Participation
30+
options:
31+
- label: I am willing to submit a pull request for this change.
32+
required: false
33+
- type: textarea
34+
attributes:
35+
label: Additional comments
36+
description: Is there anything else you'd like to mention?

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🗣 Ask a Question, Discuss
4+
url: https://github.com/eslint/espree/discussions
5+
about: Get help using ESLint

‎.github/ISSUE_TEMPLATE/docs.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "\U0001F4DD Documentation Change"
2+
description: "Request an improvement to documentation"
3+
title: "Docs: (fill in)"
4+
labels:
5+
- documentation
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Which packages would you like to change?
10+
options:
11+
- label: "`espree`"
12+
required: false
13+
- type: textarea
14+
attributes:
15+
label: What documentation issue do you want to solve?
16+
description: |
17+
Please explain your issue in as much detail as possible.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: What do you think is the correct solution?
23+
description: |
24+
Please explain how you'd like to change the ESLint docs to address the problem.
25+
validations:
26+
required: true
27+
- type: checkboxes
28+
attributes:
29+
label: Participation
30+
options:
31+
- label: I am willing to submit a pull request for this change.
32+
required: false
33+
- type: textarea
34+
attributes:
35+
label: Additional comments
36+
description: Is there anything else you'd like to mention?

0 commit comments

Comments
 (0)