From 50e359e8f7eed40004361ef5bd65d76ee5211923 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Fri, 24 Nov 2023 15:51:28 +0100 Subject: [PATCH] chore: streamline issue templates --- .../ISSUE_TEMPLATE/01-bug-report-plugin.yaml | 6 ++--- .../02-enhancement-rule-option.yaml | 8 +++---- .../03-enhancement-new-rule.yaml | 6 ++--- ...4-enhancement-new-base-rule-extension.yaml | 6 ++--- .../05-documentation-request.yml | 4 ++-- .../ISSUE_TEMPLATE/06-bug-report-other.yaml | 6 ++--- .../ISSUE_TEMPLATE/07-enhancement-other.yaml | 24 ++----------------- .../ISSUE_TEMPLATE/08-bug-report-complex.yaml | 7 +++--- .github/ISSUE_TEMPLATE/09-config-change.yaml | 2 +- .../ISSUE_TEMPLATE/10-repo-maintenance.yaml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- 11 files changed, 27 insertions(+), 48 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-bug-report-plugin.yaml b/.github/ISSUE_TEMPLATE/01-bug-report-plugin.yaml index 89fe40a297f6..1822b857c44c 100644 --- a/.github/ISSUE_TEMPLATE/01-bug-report-plugin.yaml +++ b/.github/ISSUE_TEMPLATE/01-bug-report-plugin.yaml @@ -1,5 +1,5 @@ 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] ' labels: - bug @@ -7,7 +7,7 @@ labels: - 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! @@ -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 diff --git a/.github/ISSUE_TEMPLATE/02-enhancement-rule-option.yaml b/.github/ISSUE_TEMPLATE/02-enhancement-rule-option.yaml index 683aa4aabb38..2ea82b2ad19e 100644 --- a/.github/ISSUE_TEMPLATE/02-enhancement-rule-option.yaml +++ b/.github/ISSUE_TEMPLATE/02-enhancement-rule-option.yaml @@ -1,5 +1,5 @@ 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] ' labels: - 'enhancement: plugin rule option' @@ -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! @@ -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: @@ -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: diff --git a/.github/ISSUE_TEMPLATE/03-enhancement-new-rule.yaml b/.github/ISSUE_TEMPLATE/03-enhancement-new-rule.yaml index 0065b2f24617..dd9bf8b0f1a1 100644 --- a/.github/ISSUE_TEMPLATE/03-enhancement-new-rule.yaml +++ b/.github/ISSUE_TEMPLATE/03-enhancement-new-rule.yaml @@ -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! @@ -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: @@ -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: diff --git a/.github/ISSUE_TEMPLATE/04-enhancement-new-base-rule-extension.yaml b/.github/ISSUE_TEMPLATE/04-enhancement-new-base-rule-extension.yaml index 49f03f9e6fb2..28f6699b3fb7 100644 --- a/.github/ISSUE_TEMPLATE/04-enhancement-new-base-rule-extension.yaml +++ b/.github/ISSUE_TEMPLATE/04-enhancement-new-base-rule-extension.yaml @@ -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! @@ -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: @@ -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: diff --git a/.github/ISSUE_TEMPLATE/05-documentation-request.yml b/.github/ISSUE_TEMPLATE/05-documentation-request.yml index be98ea3587f0..742a1a03d300 100644 --- a/.github/ISSUE_TEMPLATE/05-documentation-request.yml +++ b/.github/ISSUE_TEMPLATE/05-documentation-request.yml @@ -1,12 +1,12 @@ name: '📝 Documentation' -description: 'Request a change in documentation' +description: 'Adding or improving in docs' title: 'Docs: ' 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: diff --git a/.github/ISSUE_TEMPLATE/06-bug-report-other.yaml b/.github/ISSUE_TEMPLATE/06-bug-report-other.yaml index 8f4dc860625a..a7da8ab04c37 100644 --- a/.github/ISSUE_TEMPLATE/06-bug-report-other.yaml +++ b/.github/ISSUE_TEMPLATE/06-bug-report-other.yaml @@ -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: ' 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! @@ -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 diff --git a/.github/ISSUE_TEMPLATE/07-enhancement-other.yaml b/.github/ISSUE_TEMPLATE/07-enhancement-other.yaml index bd15be8306f5..2d586fc7c8ba 100644 --- a/.github/ISSUE_TEMPLATE/07-enhancement-other.yaml +++ b/.github/ISSUE_TEMPLATE/07-enhancement-other.yaml @@ -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: ' 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! @@ -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: diff --git a/.github/ISSUE_TEMPLATE/08-bug-report-complex.yaml b/.github/ISSUE_TEMPLATE/08-bug-report-complex.yaml index a4b1a883fa3d..70f584917464 100644 --- a/.github/ISSUE_TEMPLATE/08-bug-report-complex.yaml +++ b/.github/ISSUE_TEMPLATE/08-bug-report-complex.yaml @@ -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: ' 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! diff --git a/.github/ISSUE_TEMPLATE/09-config-change.yaml b/.github/ISSUE_TEMPLATE/09-config-change.yaml index b18ae438e6af..0e3e438f8a5b 100644 --- a/.github/ISSUE_TEMPLATE/09-config-change.yaml +++ b/.github/ISSUE_TEMPLATE/09-config-change.yaml @@ -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! diff --git a/.github/ISSUE_TEMPLATE/10-repo-maintenance.yaml b/.github/ISSUE_TEMPLATE/10-repo-maintenance.yaml index 24a15e85d532..0a6dc3b024da 100644 --- a/.github/ISSUE_TEMPLATE/10-repo-maintenance.yaml +++ b/.github/ISSUE_TEMPLATE/10-repo-maintenance.yaml @@ -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: ' labels: - 'repo maintenance' diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f8f0ec0f29d9..bc681b741523 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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!