From 3f1510d4ff321c2dc6c4a92cc6bc573658c38075 Mon Sep 17 00:00:00 2001 From: Gordon Date: Tue, 24 Aug 2021 12:11:58 +0200 Subject: [PATCH 1/3] docs: use gh issue forms for bug reports --- .github/ISSUE_TEMPLATE/bug-report.md | 43 ----------- .github/ISSUE_TEMPLATE/bug_report.yaml | 98 ++++++++++++++++++++++++++ 2 files changed, 98 insertions(+), 43 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 14f9a2d8..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**What package are you using? What version?** - -**What platform is it about?** -- [ ] Android -- [ ] iOS -- [ ] Web -- [ ] Windows -- [ ] MacOS -- [ ] Linux - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Logs ** -Run `flutter analyze` and attach any output of that command below. -If there are any analysis errors, try resolving them before filing this issue. - -Paste the output of running `flutter doctor -v` here. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..64146824 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,98 @@ +name: Bug Report +description: Create a report to help us improve +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: dropdown + id: packages + attributes: + label: Which packages are you using? + description: You may select more than one. + multiple: true + options: + - stream_chat + - stream_chat_flutter + - stream_chat_flutter_core + - stream_chat_persistance + - stream_chat_localizations + validations: + required: true + - type: dropdown + id: platforms + attributes: + label: On what platforms did you experience the issue? + description: You may select more than one. + multiple: true + options: + - iOS + - Android + - Web + - Windows + - MacOS + - Linux + validations: + required: true + - type: textarea + id: version + attributes: + label: What version are you using? + description: Please specify the package names and versions + placeholder: package - version + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also, what did you expect to happen? + placeholder: Description of the bug and what was expected. + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: Steps to reproduce + description: How do you trigger this bug? Please walk us through it step by step. + value: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + ... + render: bash + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Supporting info to reproduce + description: Please add any relevant code, screenshots and info needed to reproduce this issue. + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: textarea + id: flutter-analyze + attributes: + label: Flutter analyze output + description: Paste the output of `flutter analyze` here. + placeholder: If there are any analysis errors, try resolving them before filing this issue. + render: shell + - type: textarea + id: flutter-doctor + attributes: + label: Flutter doctor output + description: Paste the output of `flutter doctor -v` here. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GetStream/stream-chat-flutter/blob/develop/CODE_OF_CONDUCT.md) + options: + - label: "I agree to follow this project's Code of Conduct" + required: true From 12112406f4759a241a684468f3f70f5ac610fe12 Mon Sep 17 00:00:00 2001 From: Gordon Date: Tue, 24 Aug 2021 12:13:53 +0200 Subject: [PATCH 2/3] docs: use gh issue forms for feature requests --- .github/ISSUE_TEMPLATE/feature_request.md | 20 ------- .github/ISSUE_TEMPLATE/feature_request.yaml | 66 +++++++++++++++++++++ 2 files changed, 66 insertions(+), 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..20e36ad3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,66 @@ +name: Feature Request +description: Suggest an idea for this project +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to help us improve! + - type: dropdown + id: packages + attributes: + label: Please select which package this feature is related to. + description: You may select more than one. + multiple: true + options: + - stream_chat + - stream_chat_flutter + - stream_chat_flutter_core + - stream_chat_persistance + - stream_chat_localizations + validations: + required: true + - type: dropdown + id: platforms + attributes: + label: Which platforms would this feature impact? + description: You may select more than one. + multiple: true + options: + - iOS + - Android + - Web + - Windows + - MacOS + - Linux + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear description of what the problem is. + placeholder: "Example: I'm always frustrated when [...]" + - type: textarea + id: solution + attributes: + label: "Describe the solution that you'd like." + description: A clear description of what you want to happen. + placeholder: "Example: When clicking this I want that." + - type: textarea + id: alternatives + attributes: + label: "Describe alternatives that you have considered" + description: "A clear description of any alternative solutions or features you've considered." + placeholder: "Example: Instead of this it should do that." + - type: textarea + id: additional + attributes: + label: "Additional context" + description: "Add any other context or screenshots about the feature request here." + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GetStream/stream-chat-flutter/blob/develop/CODE_OF_CONDUCT.md) + options: + - label: "I agree to follow this project's Code of Conduct" + required: true From 3cb0aec5040366cf67e25b915f16b03736a3ab3c Mon Sep 17 00:00:00 2001 From: Gordon Date: Tue, 24 Aug 2021 12:15:42 +0200 Subject: [PATCH 3/3] docs: fix punctuation --- .github/ISSUE_TEMPLATE/feature_request.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 20e36ad3..997171d2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -9,7 +9,7 @@ body: - type: dropdown id: packages attributes: - label: Please select which package this feature is related to. + label: Please select which package this feature is related to description: You may select more than one. multiple: true options: @@ -42,7 +42,7 @@ body: - type: textarea id: solution attributes: - label: "Describe the solution that you'd like." + label: "Describe the solution that you'd like" description: A clear description of what you want to happen. placeholder: "Example: When clicking this I want that." - type: textarea