From d274df7e3a4f60d25aa168a5d0bca25c50c83569 Mon Sep 17 00:00:00 2001 From: Shelley Vohr Date: Tue, 9 Mar 2021 13:30:32 -0800 Subject: [PATCH] chore: convert bug report template to form (#27971) * chore: update feature_request for checkboxes * chore: convert bug report template * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Charles Kerr * Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: Charles Kerr * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Charles Kerr * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Charles Kerr * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Charles Kerr * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Charles Kerr * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Charles Kerr * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Charles Kerr * Address review feedback * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: John Kleinschmidt * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: John Kleinschmidt Co-authored-by: Charles Kerr Co-authored-by: John Kleinschmidt --- .github/ISSUE_TEMPLATE/Bug_report.md | 58 ----------------- .github/ISSUE_TEMPLATE/bug_report.yml | 75 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 17 ++--- 3 files changed, 84 insertions(+), 66 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index a1a336a131..0000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve Electron - ---- - - - -### Preflight Checklist - - -* [ ] I have read the [Contributing Guidelines](https://github.com/electron/electron/blob/master/CONTRIBUTING.md) for this project. -* [ ] I agree to follow the [Code of Conduct](https://github.com/electron/electron/blob/master/CODE_OF_CONDUCT.md) that this project adheres to. -* [ ] I have searched the issue tracker for an issue that matches the one I want to file, without success. - -### Issue Details - -* **Electron Version:** - * -* **Operating System:** - * -* **Last Known Working Electron version:** - * - -### Expected Behavior - - -### Actual Behavior - - -### To Reproduce - - - - - - - - -### Screenshots - - -### Additional Information - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..6dcf3c0111 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,75 @@ +name: Bug Report +about: Report an Electron bug +title: "[Bug]: " +body: +- type: checkboxes + attributes: + label: Preflight Checklist + description: Please ensure you've completed all of the following. + options: + - label: I have read the [Contributing Guidelines](https://github.com/electron/electron/blob/master/CONTRIBUTING.md) for this project. + required: true + - label: I agree to follow the [Code of Conduct](https://github.com/electron/electron/blob/master/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://www.github.com/electron/electron/issues) for a feature request that matches the one I want to file, without success. + required: true +- type: input + attributes: + label: Electron Version + description: What version of Electron are you using? + placeholder: 12.0.0 + validations: + required: true +- type: dropdown + attributes: + label: What operating system are you using? + options: + - Windows + - macOS + - Ubuntu + - Other Linux + - Other (specify below) + validations: + required: true +- type: input + attributes: + label: Operating System Version + description: What operating system version are you using? + validations: + required: true +- type: dropdown + attributes: + label: What arch are you using? + options: + - x64 + - ia32 + - arm64 (including Apple Silicon) + - Other (specify below) + validations: + required: true +- type: input + attributes: + label: Last Known Working Electron version + description: What is the last version of Electron this worked in, if applicable? + placeholder: 11.0.0 +- type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true +- type: textarea + attributes: + label: Actual Behavior + description: A clear description of what actually happens. + validations: + required: true +- type: input + attributes: + label: Testcase Gist URL + description: If you can reproduce the issue in a standalone test case, please use [Electron Fiddle](https://github.com/electron/fiddle) to create one and to publish it as a [GitHub gist](https://gist.github.com) and put the gist URL here. This is **the best way** to ensure this issue is triaged quickly. + placeholder: https://gist.github.com/... +- type: textarea + attributes: + label: Additional Information + description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 182c8dc9c3..04aa25be36 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -3,16 +3,17 @@ about: Suggest an idea for Electron title: "[Feature Request]: " labels: "enhancement ✨" body: -- type: textarea +- type: checkboxes attributes: label: Preflight Checklist - description: Please ensure you've completed the following steps by replacing [ ] with [x] - value: | - * [ ] I have read the [Contributing Guidelines](https://github.com/electron/electron/blob/master/CONTRIBUTING.md) for this project. - * [ ] I agree to follow the [Code of Conduct](https://github.com/electron/electron/blob/master/CODE_OF_CONDUCT.md) that this project adheres to. - * [ ] I have searched the issue tracker for a feature request that matches the one I want to file, without success. - validations: - required: true + description: Please ensure you've completed all of the following. + options: + - label: I have read the [Contributing Guidelines](https://github.com/electron/electron/blob/master/CONTRIBUTING.md) for this project. + required: true + - label: I agree to follow the [Code of Conduct](https://github.com/electron/electron/blob/master/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://www.github.com/electron/electron/issues) for a feature request that matches the one I want to file, without success. + required: true - type: textarea attributes: label: Problem Description