Skip to content

Commit 9271d10

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
chore: add GitHub issue template for docs issues (#17845)
1 parent 70a686b commit 9271d10

2 files changed

Lines changed: 47 additions & 1 deletion

File tree

‎.github/ISSUE_TEMPLATE/change.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "\U0001F4DD Request a change (not rule-related)"
1+
name: "\U0001F680 Request a change (not rule-related)"
22
description: "Request a change that is not a bug fix, rule change, or new rule"
33
title: "Change Request: (fill in)"
44
labels:

‎.github/ISSUE_TEMPLATE/docs.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: "\U0001F4DD Docs"
2+
description: "Request an improvement to documentation"
3+
title: "Docs: (fill in)"
4+
labels:
5+
- documentation
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: Docs page(s)
13+
description: |
14+
What page(s) are you suggesting be changed or created?
15+
placeholder: |
16+
e.g. https://eslint.org/docs/latest/use/getting-started
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: What documentation issue do you want to solve?
22+
description: |
23+
Please explain your issue in as much detail as possible.
24+
placeholder: |
25+
The ESLint docs currently...
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: What do you think is the correct solution?
31+
description: |
32+
Please explain how you'd like to change the ESLint docs to address the problem.
33+
placeholder: |
34+
I'd like the ESLint docs to...
35+
validations:
36+
required: true
37+
- type: checkboxes
38+
attributes:
39+
label: Participation
40+
options:
41+
- label: I am willing to submit a pull request for this change.
42+
required: false
43+
- type: textarea
44+
attributes:
45+
label: Additional comments
46+
description: Is there anything else that's important for the team to know?

0 commit comments

Comments
 (0)