Skip to content

chore: add note about minimal configs to bug report forms #5123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 1, 2022
Merged

chore: add note about minimal configs to bug report forms #5123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aaaebae
chore: add note about minimal configs to bug report forms
bradzacher May 31, 2022
482693a
Update .github/ISSUE_TEMPLATE/1-bug-report-plugin.yaml
bradzacher Jun 1, 2022
d9a3f6e
Merge branch 'main' into issue-forms-clarify-config
bradzacher Jun 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .github/ISSUE_TEMPLATE/1-bug-report-plugin.yaml
View file
Open in desktop
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
View file
Open in desktop
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