bug restructure

pylhc · Sep 4, 2024 · 26f0a8c · 26f0a8c
1 parent 7042ab2
commit 26f0a8c
Showing 1 changed file with 30 additions and 28 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -7,20 +7,42 @@ body:
     attributes:
       value: |
         Before opening a bug report, please search if the problematic behavior has already been reported in the existing issues
-        and read the relevant documentation.
-        
-        ---
-        
-        Thank you for taking the time to file a bug report. To address this bug as fast as possible, we need some information.
+        and read the relevant documentation. Thank you for taking the time to file a bug report. 
 
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: Give us a clear and concise description of the problem and the expected behavior.
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: Describe the steps needed to reproduce this error.
+
+  - type: textarea
+    id: suggestions
+    attributes:
+      label: Possible Fix Implementation
+      description: If you can think of one, describe a possible implementation that would fix the issue.
+
+  - type: markdown
+    attributes:
+      value: |
+        ----
+        To help us reproduce the issue, please include the following information in your bug report:
+  
   - type: input
     id: os
     attributes:
       label: Operating System
       description: "Which operating system do you encounter the issue on? Please provide the version as well."
       placeholder: "Example: macOS Big Sur 11.5.2"
     validations:
-      required: true
+      required: false 
 
   - type: input
     id: python
@@ -29,7 +51,7 @@ body:
       description: "Please provide the full Python version under which you have observed the behavior."
       placeholder: "Example: 3.9.0"
     validations:
-      required: true
+      required: false
 
   - type: input
     id: version
@@ -38,31 +60,11 @@ body:
       description: "Please provide the full version of the package under which you have observed the behavior."
       placeholder: "Example: 1.2.0"
     validations:
-      required: true
-
-  - type: textarea
-    id: description
-    attributes:
-      label: Bug Description
-      description: Give us a clear and concise description of the problem and the expected behavior.
-    validations:
-      required: true
-
-  - type: textarea
-    id: steps
-    attributes:
-      label: Steps to Reproduce
-      description: Describe the steps needed to reproduce this error.
+      required: false
 
   - type: textarea
     id: logs
     attributes:
       label: Relevant output
       description: If applicable, provide relevant log output (no need for back-ticks here).
       render: shell
-
-  - type: textarea
-    id: suggestions
-    attributes:
-      label: Possible Fix Implementation
-      description: If you can think of one, describe a possible implementation that would fix the issue.