From 5dda094d2f0f9fb90e612cf05d9e421898c08022 Mon Sep 17 00:00:00 2001
From: Matthew Schwartz <mattschwartz@gwu.edu>
Date: Wed, 11 Dec 2024 20:31:35 -0800
Subject: [PATCH] repository: update issue template

---
 .github/ISSUE_TEMPLATE/bug_report.yml | 26 +++++++++++++++-----------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index e994df75e..d0e7e1aee 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,10 +1,10 @@
-name: Issue report
+name: Issue Report
 description: File an issue report
 body:
 - type: checkboxes
   attributes:
     label: Is there an existing issue for this?
-    description: Please search to see if an issue already exists for the bug you encountered.
+    description: Please search to see if an issue already exists for the bug you encountered. If you're unsure whether or not a previous issue matches your own, file a new issue.
     options:
     - label: I have searched the existing issues
       required: true
@@ -18,13 +18,13 @@ body:
 - type: textarea
   attributes:
     label: Current Behavior
-    description: A concise description of the issue you're experiencing.
+    description: A concise description of the issue you're experiencing. If this is a regression, please try to provide the last gamescope version where the issue did not occur for you.
   validations:
     required: false
 - type: textarea
   attributes:
-    label: Steps To Reproduce
-    description: Steps to reproduce the issue.
+    label: Steps to reproduce
+    description: Steps to reproduce the issue. The clearer the steps, the easier it will be for a developer to try and debug.
     placeholder: |
       1. Launch Dota 2 from Steam with the gamescope launch command `gamescope -f -r 120 -- %command%`...
       2. Enter a bot match
@@ -33,14 +33,17 @@ body:
     required: false
 - type: textarea
   attributes:
-    label: Hardware information
+    label: Hardware Information
     description: |
       examples:
+        - **Device type**: Steam Deck, Desktop, Laptop, etc.
         - **Distro**: SteamOS 3.6.15 (`cat /etc/os-release`)
         - **CPU**: 32-core AMD Ryzen Threadripper 7970X (`inxi` or `cat /proc/cpuinfo`)
-        - **GPU**: Advanced Micro Devices [AMD/ATI] Navi 31 [Radeon RX 7900 XT/7900 XTX/7900M] (`lspci -nn | grep VGA` or `lshw -C display -numeric` or `vulkaninfo --summary | grep deviceName`
-        - **Driver Version**: Mesa 24.2.3 or NVIDIA 560.35.03 (`vulkaninfo --summary | grep driverInfo` or `nvidia-smi`)
+        - **GPU**: Advanced Micro Devices [AMD/ATI] Navi 31 [Radeon RX 7900 XT/7900 XTX/7900M] (`lspci -nn | grep VGA` or `lshw -C display -numeric` or `vulkaninfo --summary | grep deviceName`)
+        - **Driver Version**: Mesa 24.2.3 or NVIDIA 565.77 (`vulkaninfo --summary | grep driverInfo` or `nvidia-smi`)
+        **If you're using a NVIDIA driver, please run `nvidia-bug-report.sh` and attach your `nvidia-bug-report.log.gz` in the bottom section of this form.**
     value: |
+        - Device type: 
         - Distro: 
         - CPU: 
         - GPU: 
@@ -50,7 +53,7 @@ body:
     required: false
 - type: textarea
   attributes:
-    label: Software information
+    label: Software Information
     description: |
       examples:
         - **Desktop environment**: KDE 6.1.5
@@ -81,8 +84,9 @@ body:
   attributes:
     label: Logging, screenshots, or anything else
     description: |
-      Please include any relevant logging or screenshots that will give us more context about the issue you are reporting.
-
+      Please include any relevant logging, screenshots, and a `nvidia-bug-report.tar.gz` if applicable in this section.
+      In gamescope-session, you can go to Settings -> System -> Create Report -> Save to Desktop in Steam to generate a basic system report, which includes systemd-journald logs.
+      
       Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
   validations:
     required: false