Skip to content

Commit

Permalink
chore: add note about minimal configs to bug report forms (#5123)
Browse files Browse the repository at this point in the history
* chore: add note about minimal configs to bug report forms

* Update .github/ISSUE_TEMPLATE/1-bug-report-plugin.yaml

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>
  • Loading branch information
bradzacher and JoshuaKGoldberg committed Jun 1, 2022
1 parent a7fddd0 commit 316f6ba
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
11 changes: 9 additions & 2 deletions .github/ISSUE_TEMPLATE/1-bug-report-plugin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ body:
***Please do not use this template.*** Instead, select the
["Report a complex bug you encountered by providing an isolated reproduction repository" template](https://github.com/typescript-eslint/typescript-eslint/issues/new?template=7-bug-report-complex.yaml).
***Help us to help you!***
placeholder: https://typescript-eslint.io/play/...
validations:
required: true
Expand All @@ -47,7 +48,11 @@ body:
id: eslint-config
attributes:
label: ESLint Config
description: A ***minimal*** ESLint config for reproducing the issue
description: |
A ***minimal*** ESLint config for reproducing the issue.
Please do not just paste your entire ESLint config - it just makes it harder for us to investigate.
If this is more than around 30 lines and/or contains lint rule settings unrelated to your bug report, you probably haven't isolated the repro.
***Help us to help you!***
render: javascript
value: |
module.exports = {
Expand Down Expand Up @@ -90,7 +95,9 @@ body:
id: additional
attributes:
label: Additional Info
description: Any additional info you'd like to provide. If ESLint threw an exception, please run your lint again with the `--debug` flag, and dump the output below. e.g. `eslint --ext ".ts,.js" src --debug`
description: |
Any additional info you'd like to provide.
If ESLint threw an exception, please run your lint again with the `--debug` flag, and dump the output below. e.g. `eslint path/to/broken/file.ts --debug`
- type: textarea
id: versions
attributes:
Expand Down
11 changes: 9 additions & 2 deletions .github/ISSUE_TEMPLATE/6-bug-report-other.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ body:
### Note For Complex Issues
If your issue requires some complex reproduction - such as multiple files or a specific folder structure - please do not use this template.
Instead, select the ["Report a Complex Bug With a Reproduction Repository" template](https://github.com/typescript-eslint/typescript-eslint/issues/new?template=7-bug-report-complex.yaml).
***Help us to help you!***
- type: dropdown
id: package
attributes:
Expand Down Expand Up @@ -59,7 +60,11 @@ body:
id: eslint-config
attributes:
label: ESLint Config
description: (Optional) A ***minimal*** ESLint config for reproducing the issue
description: |
(Optional) A ***minimal*** ESLint config for reproducing the issue.
Please do not just paste your entire ESLint config - it just makes it harder for us to investigate.
If this is more than around 30 lines - you probably haven't isolated the repro.
***Help us to help you!***
render: javascript
value: |
module.exports = {
Expand Down Expand Up @@ -100,7 +105,9 @@ body:
id: additional
attributes:
label: Additional Info
description: Any additional info you'd like to provide. If ESLint threw an exception, please run your lint again with the `--debug` flag, and dump the output below. i.e. `eslint --ext ".ts,.js" src --debug`
description: |
Any additional info you'd like to provide.
If ESLint threw an exception, please run your lint again with the `--debug` flag, and dump the output below. e.g. `eslint path/to/broken/file.ts --debug`
- type: textarea
id: versions
attributes:
Expand Down

0 comments on commit 316f6ba

Please sign in to comment.