From 305357c6f35ed7f020f1e5836110ae1283f16bb6 Mon Sep 17 00:00:00 2001 From: JaffaKetchup Date: Mon, 18 Jul 2022 10:17:04 +0100 Subject: [PATCH 1/2] Changed issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 61 ----------- .github/ISSUE_TEMPLATE/bug-report.yaml | 107 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 32 ------ .github/ISSUE_TEMPLATE/feature-request.yaml | 79 +++++++++++++++ 4 files changed, 186 insertions(+), 93 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 845033e6c..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -name: Bug Report -about: Create a bug report to help us improve -title: "[BUG] ..." -labels: bug, needs verification -assignees: '' - ---- - -**Describe The Bug** -A clear and concise description of what the bug is. Try to be specific and give details when possible. Don't include your `flutter doctor` report here. - -**Expected Behavior** -A clear and concise description of what you expected to happen. - -**Screenshots & Recordings** -If possible, add screenshots or recordings to help explain your problem. This can quickly improve diagnosis of the issue. - -**Additional Information** -Add any other context about the problem here, or remove this section. - ---- - -**Doctors Report** - -```shell -Paste your report from `flutter doctor` inside here -``` - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - ---- - -**Severity** -This will help us to label the issue quicker and decide what needs attention first. Only choose fatal if the entire app crashes, otherwise choose non-fatal. - -- [ ] Non-Fatal -- [ ] Fatal / App Crashes - -**Frequency/Rarity** -This will help us to label the issue quicker and decide what needs attention first. - -- [ ] Once -- [ ] Uncommon -- [ ] Common -- [ ] Always - -**Applicable Platforms** -Only select those that you've tested on - one or more. If possible, test on a variety of platforms. - -- [ ] Android -- [ ] iOS -- [ ] Web -- [ ] Windows -- [ ] Others (beta platforms) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 000000000..0648c4133 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,107 @@ +name: Bug Report +description: Create a bug report to help us improve +title: "[BUG] " +labels: ["bug", "needs verification"] +body: + - type: markdown + attributes: + value: " + # Bug Report + + Thanks for taking the time to fill out this bug report! It helps us to improve the experience for you and other developers that may be facing a similar problem. We aim to respond to bug reports as soon as possible, but it may take longer to resolve this issue depending on its complexity and severity. To help us verify the issue quicker, please include as much information as you can. + " + - type: markdown + attributes: + value: --- + - type: textarea + id: description + attributes: + label: What is the bug? + description: What were you implementing when you found this issue? What happens when the bug triggers? + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: What is the expected behaviour? + description: What do you think should have happened? + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: How can we reproduce this issue? + description: | + Please include a [minimum reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example) (preferable), otherwise detail the exact steps to reproduce this issue. + If you do not include any information here, it will take longer for us to verify your issue. + placeholder: Text automatically formatted as Dart code, on submission + render: dart + - type: textarea + id: additional-info + attributes: + label: Can you provide any other information? + description: | + Please attach any other logs, screenshots, or screen recordings. + Is there anything else you'd like to say? + - type: markdown + attributes: + value: --- + - type: dropdown + id: platform + attributes: + label: Platforms Affected + description: What platforms does this issue affect? + multiple: true + options: + - Android + - iOS + - Web + - Windows + - MacOS + - Linux + - Other + validations: + required: true + - type: dropdown + id: severity + attributes: + label: Severity + description: How much of a problem is this issue, when it does occur? + options: + - "Minimum: Allows normal functioning" + - "Obtrusive: Prevents normal functioning but causes no errors in the console" + - "Erroneous: Prevents normal functioning and causes errors in the console" + - "Fatal: Causes the application to crash" + validations: + required: true + - type: dropdown + id: frequency + attributes: + label: Frequency + description: How often does this issue occur? + options: + - "Once: Occurred on a single occasion" + - "Rarely: Occurs every so often" + - "Often: Occurs more often than when it doesn't" + - "Consistently: Always occurs at the same time and location" + validations: + required: true + - type: markdown + attributes: + value: --- + - type: checkboxes + id: terms + attributes: + label: Requirements + description: These are in place to prevent spam and unnecessary reports. + options: + - label: I agree to follow this project's [Code of Conduct](https://github.com/fleaflet/flutter_map/blob/master/CODE_OF_CONDUCT.md) + required: true + - label: My Flutter/Dart installation is unaltered, and `flutter doctor` finds no relevant issues + required: true + - label: I am using the [latest stable version](https://pub.dev/packages/flutter_map) of this package + required: true + - label: I have checked the [Common Issues](https://docs.fleaflet.dev/usage/common-issues) documentation page + required: true + - label: I have checked for similar issues which may be duplicates + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 722d81def..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for this project -title: "[FEATURE] ..." -labels: enhancement -assignees: '' - ---- - -**Describe The Problem** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe Your Solution** -A clear and concise description of what you want to happen. - -**Alternatives/Workarounds** -A clear and concise description of any alternative solutions or features you've considered. - ---- - -**Additional Information** -Add any other context or screenshots about the feature request here. - -**Applicable Platforms** -Select platforms that this request applies to. - -- [ ] All/any -- [ ] Android -- [ ] iOS -- [ ] Web -- [ ] Windows -- [ ] Others (beta platforms) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 000000000..7e042184f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,79 @@ +name: Feature Request +description: Suggest functionality that you'd like to see +title: "[FEATURE] " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: " + # Feature Request + + Thanks for taking the time to let us know what you want to see! It helps us to improve the experience for you and other developers that may be facing a similar problem. Unfortunately, response times for feature requests are longer than bug reports, as they are lower priority. If you want this functionality implemented quickly, please make a Pull Request to go alongside this feature request. + " + - type: markdown + attributes: + value: --- + - type: textarea + id: description + attributes: + label: What do you want implemented? + description: Give as much detail as you can. Include why you need this feature in the first place, and any potential ideas for implementation. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: What other alternatives are available? + description: Have you used any workarounds, for example? + - type: textarea + id: additional-info + attributes: + label: Can you provide any other information? + description: | + Please attach any other logs, screenshots, or screen recordings. + Is there anything else you'd like to say? + - type: markdown + attributes: + value: --- + - type: dropdown + id: platform + attributes: + label: Platforms Affected + description: What platforms does this issue affect? + multiple: true + options: + - Android + - iOS + - Web + - Windows + - MacOS + - Linux + - Other + validations: + required: true + - type: dropdown + id: severity + attributes: + label: Severity + description: How much of a problem is the lack of functionality for you? + options: + - "Minimum: Not required for my use" + - "Annoying: Currently have to use workarounds" + - "Obtrusive: No workarounds are available, and this is essential to me" + validations: + required: true + - type: markdown + attributes: + value: --- + - type: checkboxes + id: terms + attributes: + label: Requirements + description: These are in place to prevent spam and unnecessary reports. + options: + - label: I agree to follow this project's [Code of Conduct](https://github.com/fleaflet/flutter_map/blob/master/CODE_OF_CONDUCT.md) + required: true + - label: I am using the [latest stable version](https://pub.dev/packages/flutter_map) of this package + required: true + - label: I have checked for similar feature requests which may be duplicates + required: true From 63bb791c9aa326b5482d4b5f823c4839580ee38d Mon Sep 17 00:00:00 2001 From: JaffaKetchup Date: Mon, 18 Jul 2022 10:38:23 +0100 Subject: [PATCH 2/2] Fixed spelling mistake --- .github/ISSUE_TEMPLATE/bug-report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 0648c4133..5f62b2db9 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -32,7 +32,7 @@ body: attributes: label: How can we reproduce this issue? description: | - Please include a [minimum reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example) (preferable), otherwise detail the exact steps to reproduce this issue. + Please include a [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example) (preferable), otherwise detail the exact steps to reproduce this issue. If you do not include any information here, it will take longer for us to verify your issue. placeholder: Text automatically formatted as Dart code, on submission render: dart