Skip to content

Commit 2200c43

Browse files
authoredOct 19, 2023
docs: add issue templates (#130)
1 parent fba650a commit 2200c43

File tree

3 files changed

+94
-0
lines changed

3 files changed

+94
-0
lines changed
 

‎.github/ISSUE_TEMPLATE/bug-report.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: "\U0001F41E Report a problem"
2+
description: "Report an issue with eslint-plugin-n"
3+
title: "Bug: (fill in)"
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: By opening an issue, you agree to abide by the [Open JS Foundation Code of Conduct](https://eslint.org/conduct).
10+
- type: textarea
11+
attributes:
12+
label: Environment
13+
description: |
14+
Please tell us about how you're running ESLint.
15+
value: |
16+
Node version:
17+
npm version:
18+
ESLint version:
19+
eslint-plugin-n version:
20+
Operating System:
21+
validations:
22+
required: true
23+
- type: input
24+
attributes:
25+
label: What rule do you want to report?
26+
description: Please provide the name of the rule you're having problems with.
27+
validations:
28+
required: true
29+
- type: input
30+
attributes:
31+
label: Link to Minimal Reproducible Example
32+
description: 'Link to a [playground](https://eslint-online-playground.netlify.app/), [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.'
33+
placeholder: 'https://eslint-online-playground.netlify.app/#'
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: What did you expect to happen?
39+
description: |
40+
You can use Markdown in this field.
41+
validations:
42+
required: true
43+
- type: checkboxes
44+
attributes:
45+
label: Participation
46+
options:
47+
- label: I am willing to submit a pull request for this issue.
48+
required: false
49+
- type: textarea
50+
attributes:
51+
label: Additional comments
52+
description: Is there anything else that's important for the team to know?

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/new-rule.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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: dropdown
18+
attributes:
19+
label: What type of rule is this?
20+
options:
21+
- Warns about a potential problem
22+
- Suggests an alternate way of doing something
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Example code
28+
description: Please provide some example JavaScript code that this rule will warn about. This field will render as JavaScript.
29+
render: js
30+
validations:
31+
required: true
32+
- type: checkboxes
33+
attributes:
34+
label: Participation
35+
options:
36+
- label: I am willing to submit a pull request to implement this rule.
37+
required: false
38+
- type: textarea
39+
attributes:
40+
label: Additional comments
41+
description: Is there anything else that's important for the team to know?

0 commit comments

Comments
 (0)
Please sign in to comment.