From a2aac62987b8073601955ab4a24d775507efe7fd Mon Sep 17 00:00:00 2001
From: Erin Schnabel <erinschnabel@gmail.com>
Date: Wed, 11 Dec 2024 19:18:40 -0500
Subject: [PATCH] Update and rename bug_report.md to bug_report.yaml

change bug template
---
 .github/ISSUE_TEMPLATE/bug_report.md   | 30 -----------
 .github/ISSUE_TEMPLATE/bug_report.yaml | 70 ++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 30 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 8383a3cda..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-name: Bug report
-about: 'Something doesn''t work or look right... '
-title: "\U0001F41B "
-labels: bug
-assignees: ''
-
----
-
-<!-- Describe the bug -->
-A clear and concise summary of what the bug is. Include the name/source of the badly rendered note, if applicable.
-
-<!-- What was the expected behavior -->
-A clear and concise description of what you expected to happen. A text snippet is helpful.
-
-<!-- What actually happened -->
-A clear and concise description of what actually happened. A text snippet is helpful.
-
-## Configuration
-
-<!-- Update the following to match your situation -->
-- **OS**: Windows, Linux (distro), MacOS, MacOS M1
-- **CLI version**: output using the `--version` command
-- **CLI type**: jar (java or jbang) or native command
-
-**Sources**:
-- enabled sources
-- custom templates (attach if possible)
-
-<!-- Run with the `--log` option and attach the generated log file -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
new file mode 100644
index 000000000..6f26bce46
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,70 @@
+name: Bug Report
+description: File a bug report
+title: "🐛 "
+labels: ["type: bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Before you start
+
+        - [Check for updates](https://github.com/ebullient/ttrpg-convert-cli/releases) and make sure you're running the latest version.
+        - Look at existing bug reports to see if your issue has already been reported.
+        - Is this actually a bug?
+            - [Get Help](https://github.com/ebullient/ttrpg-convert-cli/tree/main#where-to-find-help) if you aren't confident you're doing things right.
+            - If this is something that you wish the tool could do, start a discussion or create a feature request instead.
+
+        > [!TIP]
+        >
+        > - 🚜 [**Review the changelog**](https://github.com/ebullient/ttrpg-convert-cli/blob/main/CHANGELOG.md) for new capabilities (✨) and breaking changes (🔥💥).
+        > - 🔮 Check out [**Conventions**](https://github.com/ebullient/ttrpg-convert-cli/blob/main/README.md#conventions) and  [**Recommendations**](https://github.com/ebullient/ttrpg-convert-cli/blob/main/README.md#recommendations-for-using-the-cli).
+        > - 🔥 Support for the 5e 2024 ruleset is [in progress](https://github.com/ebullient/ttrpg-convert-cli/discussions/586).
+        >      Messages you may see related to XPHB, XMM, XDMG, or HP formulas are all related to this change
+
+  - type: textarea
+    id: the-problem
+    attributes:
+      label: Describe the bug
+      description: |
+        A clear and concise summary of what the bug is.
+
+        Include an example and/or specific details about the resource in question.
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        Please provide a log file.
+
+        Run the command that exibits this bug as you usually would, but add the `--log` option.
+        [Attach the `ttrpg-convert.out.txt` file](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files) that is created as a result.
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen instead?
+    validations:
+      required: true
+
+  - type: input
+    id: cli-version
+    attributes:
+      label: TTRPG CLI Version
+      description: Which version are you using? (paste the output of [`--version`](https://github.com/ebullient/ttrpg-convert-cli/tree/7650c2785f05051fa64d95ec1f49d664ce4c2805#convert-5etools-json-data))
+      placeholder: 2.3.18
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: operating-systems
+    attributes:
+      label: Which Operating Systems have you experienced this on?
+      description: You may select more than one.
+      options:
+        - label: Android
+        - label: iPhone/iPad
+        - label: Linux
+        - label: macOS
+        - label: Windows