Skip to content

Commit

Permalink
docs: added issue template for docs request (#4111)
Browse files Browse the repository at this point in the history
* docs: added issue template for docs request

* docs: added .yml form too

* add missing colon

Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
  • Loading branch information
Josh Goldberg and bradzacher committed Nov 11, 2021
1 parent 2307a17 commit 981490d
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: 'Documentation request'
about: Request a change in documentation
title: 'Docs: '
labels: 'documentation, triage'
assignees: ''
---

<!--
Please don't ignore this template.
If you ignore it, we're just going to respond asking you to fill it out, which wastes everyone's time.
The more relevant information you can include, the faster we can find the issue and fix it without asking you for more info.
-->

- [ ] I have looked on [typescript-eslint.io](https://typescript-eslint.io).
- [ ] 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.

## Suggested Changes

<!-- What would you like to see happen in the docs? -->

## Affected URL(s)

<!-- Which URL(s) on the website does this CRUD? -->
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Documentation request
description: Request a change in documentation
title: "Docs: "
labels:
- documentation
- triage
body:
- type: markdown
attributes:
value: |
Before opening a new issue:
- Read through [typescript-eslint.io](https://typescript-eslint.io)
- Look for existing [open or closed documentation requests](https://github.com/typescript-eslint/typescript-eslint/issues?q=label%3Adocumentation)
- If your request is for help, not documentation, please ask on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript-eslint)
- type: textarea
attributes:
label: Suggested Changes
description: What would you like to see happen in the docs?
validations:
required: true
- type: textarea
attributes:
label: Affected URL(s)
description: Which URL(s) on the website does this CRUD?
validations:
required: true

0 comments on commit 981490d

Please sign in to comment.