From b905318aa8a47dfdc26e2b4d8cb308920ca1b55b Mon Sep 17 00:00:00 2001 From: Francisco Bernal Date: Thu, 19 Sep 2024 21:16:26 -0700 Subject: [PATCH] chore: bug report template --- .github/ISSUE_TEMPLATE/bug_report.yml | 86 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/issue-report.md | 42 ------------- 3 files changed, 87 insertions(+), 42 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/issue-report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..9e6ffb23 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,86 @@ +name: Bug Report +description: Report a bug +labels: [ 'bug' ] +body: + - type: markdown + attributes: + value: | + Please fill out the sections below to help everyone identify and fix the bug. + - type: textarea + id: description + attributes: + label: Describe your issue. If applicable, add screenshots to help explain your problem. + description: Add a clear and concise description of what the bug is. + placeholder: Description... + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: What is the expected result? + description: Add a clear and concise description of what you expected to happen. + placeholder: Expected result... + validations: + required: true + - type: dropdown + id: tried_example_app + attributes: + label: Did you try our example app? + multiple: false + options: + - '' + - 'No' + - 'Yes' + validations: + required: true + - type: dropdown + id: reproducible_in_example_app + attributes: + label: Is it reproducible in the example app? + multiple: false + options: + - '' + - 'No' + - 'Yes' + validations: + required: true + - type: dropdown + id: reproducible_mobile_os + attributes: + label: Reproducible in which OS? + multiple: true + options: + - 'iOS' + - 'Android' + - 'iOS and Android' + validations: + required: true + - type: textarea + id: flutter_doctor + attributes: + label: Flutter/Dart Version? + description: Run `flutter doctor` and paste the output here. + placeholder: flutter doctor... + - type: textarea + id: plugin_version + attributes: + label: Plugin Version? + description: What plugin version are you using? + placeholder: Plugin version... + validations: + required: true + - type: markdown + attributes: + value: | + Thanks for reporting this issue! We will get back to you as soon as possible. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3ba13e0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/issue-report.md b/.github/ISSUE_TEMPLATE/issue-report.md deleted file mode 100644 index d0b2d68a..00000000 --- a/.github/ISSUE_TEMPLATE/issue-report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Issue report -about: Create a report to help us improve -title: "" -labels: '' -assignees: '' - ---- - -**PLEASE FILL THIS** before submitting your issue. We have noticed that many people do **NOT** know how to report an issue, please follow this guide to report your issue, otherwise we wont be able to help you. - -**NOTE**: Did you try our example app? If not, then stop try our example app and try to reproduce with it? If your app is failing and not the example app then it might be something related to your app. If the example app also fails then it is more likely for us to help you. - -**Title**: In a few words summarize your issue. This is a short title. - -**Describe the bug** -A clear and concise description of what the Issue is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**NOTE**: Did you try our example app? If not, then stop try our example app and try to reproduce with it? If your app is failing and not the example app then it might be something related to your app. If the example app also fails then it is more likely for us to help you. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Platform (please complete the following information):** - - OS: [e.g. iOS, Androit] - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Flutter/Dart Version [e.g. 22] -- Plugin version - -**Additional context** -Add any other context about the problem here.