Skip to content

chore: streamline issue templates #7994

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 1 commit into from
Nov 28, 2023
Merged

chore: streamline issue templates #7994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/01-bug-report-plugin.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: '🐛 Rule Bug'
description: 'Report a bug you encountered with a lint rule'
description: 'An issue with a single lint rule'
title: 'Bug: [rule name here] <short description of the issue>'
labels:
- bug
- 'package: eslint-plugin'
- triage
body:
- type: checkboxes
id: sanity-checks
id: preliminary-checks
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A find-and-replace here: "sanity" has meaning around mental health that I've been avoiding. "preliminary" is a bit more precise in meaning here.

attributes:
label: Before You File a Bug Report 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!
Expand Down Expand Up @@ -41,7 +41,7 @@ body:
attributes:
label: Repro Code
description: A ***minimal*** code sample which reproduces the issue
render: typescript
render: TypeScript
validations:
required: true
- type: textarea
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/02-enhancement-rule-option.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: '✨ New Rule Option or Additional Check'
description: 'Propose a new lint rule option or propose that a lint rule checks more cases'
description: 'Propose a new lint rule option or that a lint rule checks more cases'
title: 'Enhancement: [rule-name] <a short description of my proposal>'
labels:
- 'enhancement: plugin rule option'
- 'package: eslint-plugin'
- triage
body:
- type: checkboxes
id: sanity-checks
id: preliminary-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!
Expand Down Expand Up @@ -46,7 +46,7 @@ body:
attributes:
label: Fail
description: Specify an example of code that should be detected and errored on.
render: typescript
render: TypeScript
value: |
var replace = 'me';
validations:
Expand All @@ -56,7 +56,7 @@ body:
attributes:
label: Pass
description: Specify an example of code that would be accepted in its place
render: typescript
render: TypeScript
value: |
const replace = 'me';
validations:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/03-enhancement-new-rule.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ labels:
- triage
body:
- type: checkboxes
id: sanity-checks
id: preliminary-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!
Expand Down Expand Up @@ -48,7 +48,7 @@ body:
attributes:
label: Fail Cases
description: Specify an example of code that should be detected and errored on.
render: typescript
render: TypeScript
value: |
var replace = 'me';
validations:
Expand All @@ -58,7 +58,7 @@ body:
attributes:
label: Pass Cases
description: Specify an example of code that would be accepted in its place
render: typescript
render: TypeScript
value: |
const replace = 'me';
validations:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/04-enhancement-new-base-rule-extension.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ body:
In some cases, ESLint provides a rule itself, but it doesn't support TypeScript syntax; either it crashes, or it ignores the syntax, or it falsely reports against it.
In these cases, we create what we call an extension rule; a rule within our plugin that has the same functionality, but also supports TypeScript.
- type: checkboxes
id: sanity-checks
id: preliminary-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!
Expand Down Expand Up @@ -55,7 +55,7 @@ body:
attributes:
label: Fail
description: Specify an example of code that should be detected and errored on.
render: typescript
render: TypeScript
value: |
var replace = 'me';
validations:
Expand All @@ -65,7 +65,7 @@ body:
attributes:
label: Pass
description: Specify an example of code that would be accepted in its place
render: typescript
render: TypeScript
value: |
const replace = 'me';
validations:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/05-documentation-request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: '📝 Documentation'
description: 'Request a change in documentation'
description: 'Adding or improving in docs'
title: 'Docs: <a short description of my proposal>'
labels:
- documentation
- triage
body:
- type: checkboxes
id: sanity-checks
id: preliminary-checks
attributes:
label: Before You File a Documentation Request Please Confirm You Have Done The Following...
options:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/06-bug-report-other.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: '🐛 Bug With Another Package'
description: 'Report a bug you encountered with another one of our packages (parser, util, scope-manager, etc)'
description: 'An issue with another one of our packages (parser, utils, etc)'
title: 'Bug: <short description of the issue>'
labels:
- bug
- triage
body:
- type: checkboxes
id: sanity-checks
id: preliminary-checks
attributes:
label: Before You File a Bug Report 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!
Expand Down Expand Up @@ -54,7 +54,7 @@ body:
attributes:
label: Repro Code
description: A ***minimal*** code sample which reproduces the issue
render: typescript
render: TypeScript
validations:
required: true
- type: textarea
Expand Down
24 changes: 2 additions & 22 deletions .github/ISSUE_TEMPLATE/07-enhancement-other.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: '✨ Enhance Another Package'
description: 'Report an enhancement to another one of our packages (parser, util, scope-manager, etc)'
description: 'Request a change to another one of our packages (parser, utils, etc)'
title: 'Enhancement: <a short description of my proposal>'
labels:
- enhancement
- triage
body:
- type: checkboxes
id: sanity-checks
id: preliminary-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!
Expand Down Expand Up @@ -48,26 +48,6 @@ body:
placeholder: I propose that the foo rule should also check for when bars are force to be a baz.
validations:
required: true
- type: textarea
id: fail-cases
attributes:
label: Fail
description: Specify an example of code that should be detected and errored on.
render: typescript
value: |
var replace = 'me';
validations:
required: true
- type: textarea
id: pass-cases
attributes:
label: Pass
description: Specify an example of code that would be accepted in its place
render: typescript
value: |
const replace = 'me';
validations:
required: true
- type: textarea
id: additional
attributes:
Expand Down
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/08-bug-report-complex.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
name: '🐛 Complex Bug With a Reproduction Repository'
description: Report a complex bug you encountered by providing an isolated reproduction repository
name: '🐛 Complex Bug With a Reproduction'
description: Report a complex bug with an isolated reproduction
title: 'Bug: <short description of the issue>'
labels:
- bug
- triage
body:
- type: markdown
id: preamble
attributes:
value: |
An isolated reproduction is one we can clone locally and get running without other projects or existing knowledge of your project. If we cannot reproduce your bug quickly with the provided steps, we may not be able to take action on this issue. Help us to help you!
- type: checkboxes
id: sanity-checks
id: preliminary-checks
attributes:
label: Before You File a Bug Report 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!
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/09-config-change.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ labels:
- triage
body:
- type: checkboxes
id: sanity-checks
id: preliminary-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!
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/10-repo-maintenance.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: '🏗 Improve Repository Maintenance'
description: Report a bug or request a feature related to developing the typescript-eslint monorepo
description: Improve the development experience for the typescript-eslint monorepo
title: 'Repo: <short description of the issue>'
labels:
- 'repo maintenance'
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
blank_issues_enabled: false
contact_links:
- name: FAQ
about: Please check out our FAQ before filing new issues
about: Please read our FAQ before filing new issues
url: https://typescript-eslint.io/linting/troubleshooting
- name: Getting Started Guide
about: If you're looking for help setting up check out our getting started guide
about: If you're looking for help setting up, check out our getting started guide
url: https://typescript-eslint.io
- name: Ask a question on Discord
about: If you just want to ask a question, consider asking it on Discord!
Expand Down