From 7431d97652b1b5756878bd6318a8a831edb96a8c Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 21 Jul 2021 11:49:52 +0200 Subject: [PATCH 01/12] chore: create bug report form --- .github/ISSUE_TEMPLATE/bug_report.yml | 52 +++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..e37ebd9b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,52 @@ +name: Bug Report +description: File a bug report +labels: [bug] +body: + - type: markdown + attributes: + value: '## User environment' + + - type: input + id: plugin_version + attributes: + label: Plugin version + description: What version of the plugin are you using? + placeholder: v4.10.1 + validations: + required: true + + - type: input + id: eslint_version + attributes: + label: ESLint version + description: What version of ESLint are you using? + placeholder: v7.31.0 + validations: + required: true + + - type: input + id: node_js_version + attributes: + label: Node.js version + description: What version of Node.js are you using? + placeholder: 14.17.3 + validations: + required: true + + - type: input + id: npm_yarn_version + attributes: + label: npm/yarn version + description: Tell us whether you use npm or yarn as your package manager, and what version. + placeholder: npm 6.14.13 + validations: + required: true + + - type: input + id: operating_system + attributes: + label: Operating system + description: Tell us what operating system you use, and what version. + placeholder: macOS Big Sur, version 11.4 + validations: + required: true From d4e736458ca039cfacbd7d75c1aaf93b6f824afe Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 21 Jul 2021 11:51:05 +0200 Subject: [PATCH 02/12] clarify description --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e37ebd9b..f528c478 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,7 +10,7 @@ body: id: plugin_version attributes: label: Plugin version - description: What version of the plugin are you using? + description: What version of `eslint-plugin-testing-library` are you using? placeholder: v4.10.1 validations: required: true From 20e3cd2d57dfe674ff80d2e245fb9b435aa6c804 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 21 Jul 2021 11:53:44 +0200 Subject: [PATCH 03/12] add textarea for bug description --- .github/ISSUE_TEMPLATE/bug_report.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f528c478..7f9a3814 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -50,3 +50,12 @@ body: placeholder: macOS Big Sur, version 11.4 validations: required: true + +- type: textarea + id: bug_description + attributes: + label: Bug description + description: "Describe the bug at a high level." + placeholder: "I was doing ..., but I expected ..." + validations: + required: true From 6a7846a0a4e2aabc9bd1c44618c08ebdf501e596 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 21 Jul 2021 11:54:28 +0200 Subject: [PATCH 04/12] indent properly --- .github/ISSUE_TEMPLATE/bug_report.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 7f9a3814..5089afac 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -51,11 +51,11 @@ body: validations: required: true -- type: textarea - id: bug_description - attributes: - label: Bug description - description: "Describe the bug at a high level." - placeholder: "I was doing ..., but I expected ..." - validations: - required: true + - type: textarea + id: bug_description + attributes: + label: Bug description + description: "Describe the bug at a high level." + placeholder: "I was doing ..., but I expected ..." + validations: + required: true From bc22940b90f3d6288e17681622b797c58e8b04d8 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 21 Jul 2021 12:06:53 +0200 Subject: [PATCH 05/12] further work --- .github/ISSUE_TEMPLATE/bug_report.yml | 68 +++++++++++++++++++++++++-- 1 file changed, 64 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5089afac..db16c30f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -32,7 +32,7 @@ body: placeholder: 14.17.3 validations: required: true - + - type: input id: npm_yarn_version attributes: @@ -41,7 +41,7 @@ body: placeholder: npm 6.14.13 validations: required: true - + - type: input id: operating_system attributes: @@ -55,7 +55,67 @@ body: id: bug_description attributes: label: Bug description - description: "Describe the bug at a high level." - placeholder: "I was doing ..., but I expected ..." + description: Describe the bug at a high level. + placeholder: I was doing ..., but I expected ... + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: Steps to reproduce + description: Give the steps to reproduce the problem + placeholder: | + 1. Go to ... + 2. Do .... + 3. See bug + validations: + required: true + + - type: textarea + id: error_output_screenshots + attributes: + label: Error output/screenshots + description: Copy/paste any error messages or helpful screenshots into this field. + placeholder: 'Tip: you can copy/paste error messages in here. You can click and drag screenshots into this field.' + validations: + required: false + + - type: textarea + id: eslint_config + attributes: + label: ESLint configuration + description: Copy/paste your ESLint configuration into this field. + placeholder: You can find your eslint configuration in these files TODO ADD LIST OF VALID FILENAMES + validations: + required: true + + - type: textarea + id: rule_affected + attributes: + label: Rules(s) affected + description: Tell us what `eslint-pluging-testing-library` rule(s) are affected by this bug. + placeholder: TODO ADD EXAMPLE OF A RULE + validations: + required: true + + - type: textarea + id: anything_else + attributes: + label: Anything else we need to know? + description: If there's anything else we need to know, tell us about it! + placeholder: Tell us anything else we need to know. + validations: + required: true + + - type: dropdown + id: want_to_submit_pr_to_fix_bug + attributes: + label: Do you want to submit a pull request to fix this bug? + options: + - 'Yes' + - 'Yes, but need help' + - 'No' validations: required: true + From 2523fad44fdb0a3115c91896c849699e288717f4 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 21 Jul 2021 12:10:27 +0200 Subject: [PATCH 06/12] further work --- .github/ISSUE_TEMPLATE/bug_report.yml | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index db16c30f..08a4329f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -2,10 +2,6 @@ name: Bug Report description: File a bug report labels: [bug] body: - - type: markdown - attributes: - value: '## User environment' - - type: input id: plugin_version attributes: @@ -64,7 +60,7 @@ body: id: steps_to_reproduce attributes: label: Steps to reproduce - description: Give the steps to reproduce the problem + description: Give us a ordered list of the steps to reproduce the problem. placeholder: | 1. Go to ... 2. Do .... @@ -86,7 +82,7 @@ body: attributes: label: ESLint configuration description: Copy/paste your ESLint configuration into this field. - placeholder: You can find your eslint configuration in these files TODO ADD LIST OF VALID FILENAMES + placeholder: You can find your ESLint configuration in these files TODO ADD LIST OF VALID FILENAMES validations: required: true @@ -102,9 +98,9 @@ body: - type: textarea id: anything_else attributes: - label: Anything else we need to know? - description: If there's anything else we need to know, tell us about it! - placeholder: Tell us anything else we need to know. + label: Anything else? + description: If there's anything else we need to know, tell us about it here. + placeholder: By the way, you also need to know about... validations: required: true @@ -118,4 +114,3 @@ body: - 'No' validations: required: true - From c4d6c8915d05a7a58d910a16097da7917abd5bb0 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 22 Jul 2021 09:57:10 +0200 Subject: [PATCH 07/12] Add tip about checking eslintrc file for rules --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 08a4329f..64fdb2e3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -91,7 +91,7 @@ body: attributes: label: Rules(s) affected description: Tell us what `eslint-pluging-testing-library` rule(s) are affected by this bug. - placeholder: TODO ADD EXAMPLE OF A RULE + placeholder: Tip: check your `.eslintrc` for rules. validations: required: true From 306622539acf415db373d6a82442b21c60e9ef53 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 22 Jul 2021 09:57:29 +0200 Subject: [PATCH 08/12] Add tip about checking eslintrc file for ESLint config --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 64fdb2e3..07c3c1c9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -82,7 +82,7 @@ body: attributes: label: ESLint configuration description: Copy/paste your ESLint configuration into this field. - placeholder: You can find your ESLint configuration in these files TODO ADD LIST OF VALID FILENAMES + placeholder: Tip: you can find your ESLint configuration in the `.eslintrc` file. validations: required: true From 60e5f0a0d6a4a6398e4f66eb5c13c26316ec7f84 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 22 Jul 2021 09:58:35 +0200 Subject: [PATCH 09/12] put placeholder sentence between single quotes --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 07c3c1c9..c1617596 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -82,7 +82,7 @@ body: attributes: label: ESLint configuration description: Copy/paste your ESLint configuration into this field. - placeholder: Tip: you can find your ESLint configuration in the `.eslintrc` file. + placeholder: 'Tip: you can find your ESLint configuration in the `.eslintrc` file.' validations: required: true From f7abf1bfbab3b655e06d4c755dcd16331824a1b8 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 22 Jul 2021 09:59:08 +0200 Subject: [PATCH 10/12] Put placeholder sentence between single quotes --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c1617596..db635e58 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -91,7 +91,7 @@ body: attributes: label: Rules(s) affected description: Tell us what `eslint-pluging-testing-library` rule(s) are affected by this bug. - placeholder: Tip: check your `.eslintrc` for rules. + placeholder: 'Tip: check your `.eslintrc` for rules.' validations: required: true From 9c1a0f36956c8a7b529e1f658cba95b276b7ad52 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 22 Jul 2021 10:47:46 +0200 Subject: [PATCH 11/12] Fix typo in label name MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Michaël De Boey --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index db635e58..dfd35d89 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -89,7 +89,7 @@ body: - type: textarea id: rule_affected attributes: - label: Rules(s) affected + label: Rule(s) affected description: Tell us what `eslint-pluging-testing-library` rule(s) are affected by this bug. placeholder: 'Tip: check your `.eslintrc` for rules.' validations: From 54497b9ebd081ed76f26a841d5313970a9347381 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 22 Jul 2021 10:48:07 +0200 Subject: [PATCH 12/12] Make anything else field optional MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Michaël De Boey --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index dfd35d89..06db2a24 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -102,7 +102,7 @@ body: description: If there's anything else we need to know, tell us about it here. placeholder: By the way, you also need to know about... validations: - required: true + required: false - type: dropdown id: want_to_submit_pr_to_fix_bug