Skip to content

Commit af2c7e3

Browse files
nzakasnzakas
committed
chore: Add issue templates
1 parent fdfe37d commit af2c7e3

File tree

3 files changed

+185
-0
lines changed

3 files changed

+185
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: "\U0001F41E Report a problem"
2+
description: 'Report an issue with a rule'
3+
title: 'Bug: (fill in)'
4+
labels:
5+
- bug
6+
- 'repro:needed'
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: By opening an issue, you agree to abide by the [Open JS Foundation Code of Conduct](https://eslint.org/conduct).
11+
- type: textarea
12+
attributes:
13+
label: What version of eslint-plugin-security are you using?
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: ESLint Environment
19+
description: |
20+
Please tell us about how you're running ESLint (Run `npx eslint --env-info`.)
21+
value: |
22+
Node version:
23+
npm version:
24+
Local ESLint version:
25+
Global ESLint version:
26+
Operating System:
27+
validations:
28+
required: true
29+
- type: dropdown
30+
attributes:
31+
label: What parser are you using?
32+
description: |
33+
Please keep in mind that some problems are parser-specific.
34+
options:
35+
- 'Default (Espree)'
36+
- '@typescript-eslint/parser'
37+
- '@babel/eslint-parser'
38+
- 'vue-eslint-parser'
39+
- '@angular-eslint/template-parser'
40+
- Other
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
label: What did you do?
46+
description: |
47+
Please include a *minimal* reproduction case. If possible, include a link to a reproduction of the problem in the [ESLint demo](https://eslint.org/demo). Otherwise, include source code, configuration file(s), and any other information about how you're using ESLint. You can use Markdown in this field.
48+
value: |
49+
<details>
50+
<summary>Configuration</summary>
51+
52+
```
53+
<!-- Paste your configuration here -->
54+
```
55+
</details>
56+
57+
```js
58+
<!-- Paste your code here -->
59+
```
60+
validations:
61+
required: true
62+
- type: textarea
63+
attributes:
64+
label: What did you expect to happen?
65+
description: |
66+
You can use Markdown in this field.
67+
validations:
68+
required: true
69+
- type: textarea
70+
attributes:
71+
label: What actually happened?
72+
description: |
73+
Please copy-paste the actual ESLint output. You can use Markdown in this field.
74+
validations:
75+
required: true
76+
- type: checkboxes
77+
attributes:
78+
label: Participation
79+
options:
80+
- label: I am willing to submit a pull request for this issue.
81+
required: false
82+
- type: textarea
83+
attributes:
84+
label: Additional comments
85+
description: Is there anything else that's important for the team to know?

‎.github/ISSUE_TEMPLATE/new-rule.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: "\U0001F680 Propose a new rule"
2+
description: 'Propose a new rule to be added to the plugin'
3+
title: 'New Rule: (fill in)'
4+
labels:
5+
- rule
6+
- feature
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: By opening an issue, you agree to abide by the [Open JS Foundation Code of Conduct](https://eslint.org/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 [CVE](https://www.redhat.com/en/topics/security/what-is-cve)
20+
description: We only accept new rules that have published CVEs.
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Example code
26+
description: Please provide some example JavaScript code that this rule will warn about. This field will render as JavaScript.
27+
render: js
28+
validations:
29+
required: true
30+
- type: checkboxes
31+
attributes:
32+
label: Participation
33+
options:
34+
- label: I am willing to submit a pull request to implement this rule.
35+
required: false
36+
- type: textarea
37+
attributes:
38+
label: Additional comments
39+
description: Is there anything else that's important for the team to know?

‎.github/ISSUE_TEMPLATE/rule-change.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: "\U0001F4DD Request a rule change"
2+
description: 'Request a change to an existing rule'
3+
title: 'Rule Change: (fill in)'
4+
labels:
5+
- enhancement
6+
- rule
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: By opening an issue, you agree to abide by the [Open JS Foundation Code of Conduct](https://eslint.org/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: What change to do you want to make?
19+
options:
20+
- Generate more warnings
21+
- Generate fewer warnings
22+
- Implement autofix
23+
- Implement suggestions
24+
validations:
25+
required: true
26+
- type: dropdown
27+
attributes:
28+
label: How do you think the change should be implemented?
29+
options:
30+
- A new option
31+
- A new default behavior
32+
- Other
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Example code
38+
description: Please provide some example code that this change will affect. This field will render as JavaScript.
39+
render: js
40+
validations:
41+
required: true
42+
- type: textarea
43+
attributes:
44+
label: What does the rule currently do for this code?
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: What will the rule do after it's changed?
50+
validations:
51+
required: true
52+
- type: checkboxes
53+
attributes:
54+
label: Participation
55+
options:
56+
- label: I am willing to submit a pull request to implement this change.
57+
required: false
58+
- type: textarea
59+
attributes:
60+
label: Additional comments
61+
description: Is there anything else that's important for the team to know?

0 commit comments

Comments
 (0)