chore: improve bug report issue template (#2716)

* chore: improve bug report issue template 1. _Firstly_ require a _minimal_ reproduce. 2. Explicitly ask what is expected and what happen instead. * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Ruihang Xia <[email protected]> --------- Co-authored-by: Ruihang Xia <[email protected]>
GreptimeTeam · Nov 13, 2023 · 3f981ef · 3f981ef
1 parent 5cff735
commit 3f981ef
Showing 1 changed file with 19 additions and 16 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -41,13 +41,27 @@ body:
       required: true
 
   - type: textarea
-    id: what-happened
+    id: reproduce
     attributes:
-      label: What happened?
+      label: Minimal reproduce step
       description: |
-        Tell us what happened and also what you would have expected to
-        happen instead.
-      placeholder: "Describe the bug"
+        Please walk us through and provide steps and details on how
+        to reproduce the issue. If possible, provide scripts that we
+        can run to trigger the bug.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-manner
+    attributes:
+      label: What did you expect to see?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-manner
+    attributes:
+      label: What did you see instead?
     validations:
       required: true
 
@@ -72,14 +86,3 @@ body:
         trace. This will be automatically formatted into code, so no
         need for backticks.
       render: bash
-
-  - type: textarea
-    id: reproduce
-    attributes:
-      label: How can we reproduce the bug?
-      description: |
-        Please walk us through and provide steps and details on how
-        to reproduce the issue. If possible, provide scripts that we
-        can run to trigger the bug.
-    validations:
-      required: true