Skip to content

chore: add issue form for config changes #5189

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ body:
- Your issue requires some complex setup - such as multiple files or a specific folder structure.

***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).
["Report a complex bug you encountered by providing an isolated reproduction repository" template](https://github.com/typescript-eslint/typescript-eslint/issues/new?template=08-bug-report-complex.yaml).
***Help us to help you!***
placeholder: https://typescript-eslint.io/play/...
validations:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ body:
value: |
### 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).
Instead, select the ["Report a Complex Bug With a Reproduction Repository" template](https://github.com/typescript-eslint/typescript-eslint/issues/new?template=08-bug-report-complex.yaml).
***Help us to help you!***
- type: dropdown
id: package
Expand Down
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/09-config-change.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: "♻ Propose a Change to Preset Configurations"
description: "Propose an addition, removal, or general change to a preset config"
title: "Configs: <a short description of my proposal>"
labels:
- "package: eslint-plugin"
- "preset config change"
- triage
body:
- type: checkboxes
id: sanity-checks
attributes:
label: Before You File a Proposal Please Confirm You Have Done The Following...
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
options:
- label: I have [searched for related issues](https://github.com/typescript-eslint/typescript-eslint/issues?q=is%3Aissue+label%3A%22preset+config+change%22+) and found none that match my proposal.
required: true
- label: I have [read the FAQ](https://typescript-eslint.io/docs/linting/troubleshooting) and my problem is not listed.
required: true
- type: textarea
id: description
attributes:
label: Description
description: Explain what your proposed config change would do and why this is useful.
placeholder: We should enable <XYZ> super duper useful fancy rule for the recommended config!
validations:
required: true
- type: textarea
id: impacted-configs
attributes:
label: Impacted Configurations
description: Which existing config(s) does this issue request changing?
- type: textarea
id: additional
attributes:
label: Additional Info
description: Any additional info you'd like to provide.
2 changes: 1 addition & 1 deletion packages/website/src/components/lib/markdown.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export function createMarkdownParams(state: ConfigModel): string {

const params = {
labels: 'bug,package: eslint-plugin,triage',
template: '1-bug-report-plugin.yaml',
template: '01-bug-report-plugin.yaml',
title: `Bug: [${onlyRuleName}] <short description of the issue>`,
'playground-link': document.location.toString(),
'repro-code': state.code,
Expand Down