From 2d040c556e491c3a5649b72cbe9dc5fb9e507f1c Mon Sep 17 00:00:00 2001
From: Zach Parks <zach@alliware.com>
Date: Wed, 19 Jun 2024 05:58:56 -0500
Subject: [PATCH] Overhaul bug report template.

---
 .github/ISSUE_TEMPLATE/bug_report.yaml | 84 +++++++++++++++++++-------
 1 file changed, 63 insertions(+), 21 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
index d4c8702da026..e875b650f8d3 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yaml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -1,35 +1,77 @@
 name: Bug Report
-description: File a bug report.
-title: "Bug: "
+description: >-
+  Report a bug or regression in the Archipelago core (Generator, MultiServer, CommonClient, etc.) or WebHost.
+title: '[Bug]: '
 labels:
-  - bug / fix
+  - 'is: bug/fix'
 body:
   - type: markdown
     attributes:
-      value: |
-        Thanks for taking the time to fill out this bug report! If this bug occurred during local generation check your 
-        Archipelago install for a log (probably `C:\ProgramData\Archipelago\logs`)
-        and upload it with this report, as well as all yaml files used.
-  - type: textarea
-    id: what-happened
+      value: >-
+        Thanks for taking the time to fill out a bug report! If this problem occurred during local generation, check
+        your Archipelago install for a log and upload it with this report, as well as any YAML files used.
+        
+        ### Note
+
+        This form should only be used in relation to core Archipelago components. All bug reports or feature requests 
+        for individual worlds (games) should instead be relayed to the maintainer(s) of the world itself.
+
+        For games currently in this repository, check the website's supported games page for a link to submit bug 
+        reports for the game, if present, or submit a bug report in our [Discord](https://discord.gg/archipelago)
+        server's [#bug-reports](https://discord.com/channels/731205301247803413/1009605416428257360) forum and ping the 
+        relevant maintainers.
+        
+        A list of maintainers for each world (game) in this repository is also documented in our 
+        [CODEOWNERS](https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/CODEOWNERS) documentation.
+  - type: input
+    id: version
     attributes:
-      label: What happened?
+      label: Archipelago Version / Operating System
+      description: >-
+        What version of Archipelago was this problem detected in?
+
+        - If running from source, include the current commit hash (`git rev-parse HEAD` returns the current hash; e.g., `f06e565`).
+        - If running from a RC, include the RC number, in addition to the version number (e.g., `0.5.0 RC2`).
+      placeholder: 0.5.0
     validations:
       required: true
-  - type: textarea
-    id: expected-results
+  - type: dropdown
+    id: affects
     attributes:
-      label: What were the expected results?
+      label: Affected Components
+      description: Select all the Archipelago components that are affected by this problem.
+      multiple: true
+      options:
+        - Generation
+        - MultiServer
+        - Launcher
+        - Client
+        - WebHost
+        - Installer
+        - Documentation
+        - AutoWorld API
+        - Other Component(s)
     validations:
       required: true
-  - type: dropdown
-    id: version
+  - type: textarea
+    id: description
     attributes:
-      label: Software
-      description: Where did this bug occur?
-      options:
-        - Website
-        - Local generation
-        - While playing
+      label: Description
+      description: A clear and concise description of the problem and what outcome was expected, if applicable.
     validations:
       required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Minimal Reproduction
+      description: Provide steps to reproduce the problem.
+  - type: textarea
+    id: files
+    attributes:
+      label: Logs & Additional Files
+      description: >-
+        Include any applicable logs, spoiler outputs, or other files that were outputted or used in relation to this 
+        problem, if applicable. 
+        
+        If the problem occurred locally, you can find these logs in your Archipelago directory by clicking `Browse Files`
+        in the Archipelago Launcher and navigating to the `logs` directory.