From e92740cc2b18b0937e6e9fe935e4ad889d7d65a8 Mon Sep 17 00:00:00 2001
From: Dani Tweig <dani.tweig@scylladb.com>
Date: Mon, 11 Nov 2024 16:03:53 +0200
Subject: [PATCH] .github: update bug_report.yml

Perform a yaml "face lift" on the old bug report md template, making bug reporting more efficient.

- Add dedicated textarea fields for problem description and expected behavior
- Include pre-filled placeholders to guide issue reporting
- Add formatted log output section with shell syntax highlighting

Closes: #21532
---
 .github/ISSUE_TEMPLATE/bug_report.yml | 97 +++++++++++++++++++++++----
 1 file changed, 84 insertions(+), 13 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 3e36171be9..ca5a7a3946 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,15 +1,86 @@
-This is Scylla's bug tracker, to be used for reporting bugs only.
+name: "Report a bug"
+description: "File a bug report."
+title: "[Bug]: "
+type: "bug"
+labels: bug
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: "This is Scylla's bug tracker, to be used for reporting bugs only.
 If you have a question about Scylla, and not a bug, please ask it in
-our mailing-list at scylladb-dev@googlegroups.com or in our slack channel.
+our forum at https://forum.scylladb.com/ or in our slack channel https://slack.scylladb.com/ "
+      options:
+        - label: I have read the disclaimer above and am reporting a suspected malfunction in Scylla.
+          required: true
 
-- [] I have read the disclaimer above, and I am reporting a suspected malfunction in Scylla.
-
-*Installation details*
-Scylla version (or git commit hash):
-Cluster size:
-OS (RHEL/CentOS/Ubuntu/AWS AMI):
-
-*Hardware details (for performance issues)*          Delete if unneeded
-Platform (physical/VM/cloud instance type/docker):
-Hardware: sockets= cores= hyperthreading= memory=
-Disks: (SSD/HDD, count)
+  - type: input
+    id: product-version
+    attributes:
+      label: product version
+      description: Scylla version (or git commit hash)
+      placeholder: ex. scylla-6.1.1
+    validations:
+      required: true
+      
+  - type: input
+    id: cluster-size
+    attributes:
+      label: Cluster Size
+    validations:
+      required: true  
+      
+  - type: input
+    id: os
+    attributes:
+      label: OS
+      placeholder: RHEL/CentOS/Ubuntu/AWS AMI
+    validations:
+      required: true
+      
+  - type: textarea
+    id: additional-data
+    attributes:
+      label: Additional Environmental Data
+      #description: 
+      placeholder: Add additional data
+      value: "Platform (physical/VM/cloud instance type/docker):\n
+Hardware: sockets=   cores=   hyperthreading=   memory=\n
+Disks: (SSD/HDD, count)"
+    validations:
+      required: false
+      
+  - type: textarea
+    id: reproducer-steps
+    attributes:
+      label: Reproduction Steps
+      placeholder: Describe how to reproduce the problem
+      value: "The steps to reproduce the problem are:"
+    validations:
+      required: true
+      
+  - type: textarea
+    id: the-problem
+    attributes:
+      label: What is the problem?
+      placeholder: Describe the problem you found
+      value: "The problem is that"
+    validations:
+      required: true
+      
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Expected behavior?
+      placeholder: Describe what should have happened
+      value: "I expected that "
+    validations:
+      required: true
+      
+  - 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