Skip to content

Commit 143a598

Browse files
nzakasbtmills
nzakas
and
btmills
authoredSep 7, 2021
Chore: Switch issues to use forms (#15024)
* Docs: Switch issues to use forms * Make title unique * Add bug report template * Fix bug report template * Add rule change template * New rule template * Clean up templates * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Brandon Mills <btmills@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/change.yml Co-authored-by: Brandon Mills <btmills@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/new-rule.yml Co-authored-by: Brandon Mills <btmills@users.noreply.github.com> Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>
·
v9.23.0v8.0.0-beta.2
1 parent f966fe6 commit 143a598

File tree

8 files changed

+225
-203
lines changed

8 files changed

+225
-203
lines changed
 

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

-78
This file was deleted.

‎.github/ISSUE_TEMPLATE/CHANGE.md

-35
This file was deleted.

‎.github/ISSUE_TEMPLATE/NEW_RULE.md

-48
This file was deleted.

‎.github/ISSUE_TEMPLATE/RULE_CHANGE.md

-42
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug-report.yml

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: "\U0001F41E Report a problem"
2+
description: "Report an issue with ESLint or rules bundled with ESLint"
3+
title: "Bug: (fill in)"
4+
labels:
5+
- bug
6+
- "repro:needed"
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: ESLint adheres to the [Open JS Foundation Code of Conduct](https://eslint.org/conduct). By opening an issue, you agree to abide by the code of conduct.
11+
- type: textarea
12+
attributes:
13+
label: Environment
14+
description: |
15+
Please tell us about how you're running ESLint (Run `npx eslint --env-info`.)
16+
value: |
17+
Node version:
18+
npm version:
19+
Local ESLint version:
20+
Global ESLint version:
21+
Operating System:
22+
validations:
23+
required: true
24+
- type: dropdown
25+
attributes:
26+
label: What parser are you using?
27+
description: |
28+
Please keep in mind that some problems are parser-specific.
29+
options:
30+
- "Default (Espree)"
31+
- "@typescript-eslint/parser"
32+
- "@babel/eslint-parser"
33+
- "vue-eslint-parser"
34+
- "@angular-eslint/template-parser"
35+
- Other
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 with source code, configuration file, any other information about how you're using ESLint. You can use Markdown in this field.
43+
value: |
44+
<details>
45+
<summary>Configuration</summary>
46+
<!-- Paste your configuration below: -->
47+
```js
48+
49+
```
50+
</details>
51+
render: markdown
52+
validations:
53+
required: true
54+
- type: textarea
55+
attributes:
56+
label: What did you expect to happen?
57+
description: |
58+
You can use Markdown in this field.
59+
render: markdown
60+
validations:
61+
required: true
62+
- type: textarea
63+
attributes:
64+
label: What actually happened?
65+
description: |
66+
Please copy-paste the actual ESLint output. You can use Markdown in this field.
67+
render: markdown
68+
validations:
69+
required: true
70+
- type: checkboxes
71+
attributes:
72+
label: Participation
73+
options:
74+
- label: I am willing to submit a pull request for this issue.
75+
required: false

‎.github/ISSUE_TEMPLATE/change.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: "\U0001F4DD Request a change (not rule-related)"
2+
description: "Request a change that is not a bug fix, rule change, or new rule"
3+
title: "Change Request: (fill in)"
4+
labels:
5+
- enhancement
6+
- triage
7+
- core
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: ESLint adheres to the [Open JS Foundation Code of Conduct](https://eslint.org/conduct). By opening an issue, you agree to abide by the code of conduct.
12+
- type: input
13+
attributes:
14+
label: ESLint version
15+
description: |
16+
What version of ESLint are you currently using? (Run `npx eslint --version`.)
17+
placeholder: |
18+
e.g. v8.0.0
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: What problem do you want to solve?
24+
description: |
25+
Please explain your use case in as much detail as possible.
26+
placeholder: |
27+
ESLint currently...
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: What do you think is the correct solution?
33+
description: |
34+
Please explain how you'd like to change ESLint to address the problem.
35+
placeholder: |
36+
I'd like ESLint to...
37+
validations:
38+
required: true
39+
- type: checkboxes
40+
attributes:
41+
label: Participation
42+
options:
43+
- label: I am willing to submit a pull request for this change.
44+
required: false

‎.github/ISSUE_TEMPLATE/new-rule.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: "\U0001F680 Propose a new core rule"
2+
description: "Propose a new rule to be added to the ESLint core"
3+
title: "New Rule: (fill in)"
4+
labels:
5+
- rule
6+
- feature
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: ESLint adheres to the [Open JS Foundation Code of Conduct](https://eslint.org/conduct). By opening an issue, you agree to abide by the code of conduct.
11+
- type: input
12+
attributes:
13+
label: Rule details
14+
description: What should the new rule do?
15+
validations:
16+
required: true
17+
- type: input
18+
attributes:
19+
label: Related ECMAScript feature
20+
description: What new ECMAScript feature does this rule relate to? Note that we only accept new core rules related to new ECMAScript features.
21+
validations:
22+
required: true
23+
- type: dropdown
24+
attributes:
25+
label: What type of rule is this?
26+
options:
27+
- Warns about a potential problem
28+
- Suggests an alternate way of doing something
29+
- Enforces a formatting/stylistic preference
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Example code
35+
description: Please provide some example JavaScript code that this rule will warn about. This field will render as JavaScript.
36+
render: js
37+
validations:
38+
required: true
39+
- type: textarea
40+
attributes:
41+
label: Why should this rule be in the core instead of a plugin?
42+
description: In general, we prefer that rules be implemented in plugins where they can be tailored to your specific use case.
43+
validations:
44+
required: true
45+
- type: checkboxes
46+
attributes:
47+
label: Participation
48+
options:
49+
- label: I am willing to submit a pull request to implement this rule.
50+
required: false

‎.github/ISSUE_TEMPLATE/rule-change.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: "\U0001F4DD Request a rule change"
2+
description: "Request a change to an existing core rule"
3+
title: "Rule Change: (fill in)"
4+
labels:
5+
- enhancement
6+
- rule
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: ESLint adheres to the [Open JS Foundation Code of Conduct](https://eslint.org/conduct). By opening an issue, you agree to abide by the code of conduct.
11+
- type: input
12+
attributes:
13+
label: What rule do you want to change?
14+
validations:
15+
required: true
16+
- type: dropdown
17+
attributes:
18+
label: Does this change cause the rule to produce more or fewer warnings?
19+
options:
20+
- More warnings
21+
- Fewer warnings
22+
- No change to warnings
23+
validations:
24+
required: true
25+
- type: dropdown
26+
attributes:
27+
label: How do you think the change should be implemented?
28+
options:
29+
- A new option
30+
- A new default behavior
31+
- Other
32+
validations:
33+
required: true
34+
- type: textarea
35+
attributes:
36+
label: Example code
37+
description: Please provide some example code that this change will affect. This field will render as JavaScript.
38+
render: js
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: What does the rule currently do for this code?
44+
validations:
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: What will the rule do after it's changed?
49+
validations:
50+
required: true
51+
- type: checkboxes
52+
attributes:
53+
label: Participation
54+
options:
55+
- label: I am willing to submit a pull request to implement this change.
56+
required: false

0 commit comments

Comments
 (0)
Please sign in to comment.