docs: use gh issue forms for bug reports

2021-08-24 12:11:58 +02:00
parent 25d15e213c
commit 3f1510d4ff
2 changed files with 98 additions and 43 deletions
@@ -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.
@@ -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