8000 docs: added issue template for docs request (#4111) · thdk/typescript-eslint@981490d · GitHub
[go: up one dir, main page]
Skip to content

Commit 981490d

Browse files
Josh Goldbergbradzacher
Josh Goldberg
and
bradzacher
authored
docs: added issue template for docs request (typescript-eslint#4111)
* docs: added issue template for docs request * docs: added .yml form too * add missing colon Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
1 parent 2307a17 commit 981490d

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

‎.github/ISSUE_TEMPLATE/documentation-request.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: 'Documentation request'
3+
about: Request a change in documentation
4+
title: 'Docs: '
5+
labels: 'documentation, triage'
6+
assignees: ''
7+
---
8+
9+
<!--
10+
Please don't ignore this template.
11+
12+
If you ignore it, we're just going to respond asking you to fill it out, which wastes everyone's time.
13+
The more relevant information you can include, the faster we can find the issue and fix it without asking you for more info.
14+
-->
15+
16+
- [ ] I have looked on [typescript-eslint.io](https://typescript-eslint.io).
17+
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
18+
19+
## Suggested Changes
20+
21+
<!-- What would you like to see happen in the docs? -->
22+
23+
## Affected URL(s)
24+
25+
<!-- Which URL(s) on the website does this CRUD? -->

‎.github/ISSUE_TEMPLATE/documentation-request.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Documentation request
2+
description: Request a change in documentation
3+
title: "Docs: "
4+
labels:
5+
- documentation
6+
- triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Before opening a new issue:
12+
- Read through [typescript-eslint.io](https://typescript-eslint.io)
13+
- Look for existing [open or closed documentation requests](https://github.com/typescript-eslint/typescript-eslint/issues?q=label%3Adocumentation)
14+
- If your request is for help, not documentation, please ask on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript-eslint)
15+
- type: textarea
16+
attributes:
17+
label: Suggested Changes
18+
description: What would you like to see happen in the docs?
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Affected URL(s)
24+
description: Which URL(s) on the website does this CRUD?
25+
validations:
26+
required: true

0 commit comments

Comments
 (0)
0