[GITHUB] Add Links to Guides in Issue Templates (#4053)

* Issues Guide in bug template * Issues Guide in charting template * Guide links in compiling template * Issues Guide in crash template * Issues Guide in enhancement template
FunkinCrew · Jan 27, 2025 · df142a9 · df142a9
1 parent 47e320e
commit df142a9
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 13 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -8,8 +8,9 @@ body:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your issue being addressed!
       options:
-        - label: I have properly named my issue
+        - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050)
         - label: I have checked the Issues/Discussions pages to see if my issue has already been reported
+        - label: I have properly named my issue
 
   - type: dropdown
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/charting.yml b/.github/ISSUE_TEMPLATE/charting.yml
@@ -8,8 +8,9 @@ body:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your issue being addressed!
       options:
-        - label: I have properly named my issue
+        - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050)
         - label: I have checked the Issues/Discussions pages to see if my issue has already been reported
+        - label: I have properly named my issue
 
   - type: dropdown
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/compiling.yml b/.github/ISSUE_TEMPLATE/compiling.yml
@@ -1,23 +1,27 @@
-name: Compiling Report
+name: Compiling Help
 description: Report an issue with compiling the game.
 labels: ["type: compilation help", "status: pending triage"]
-title: "Compiling Report: "
+title: "Compiling Help: "
 body:
   - type: checkboxes
     attributes:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your issue being addressed!
       options:
-        - label: I have properly named my issue
+        - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050)
+        - label: I have followed the [Compiling Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/COMPILING.md) and the [Troubleshooting Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/TROUBLESHOOTING.md)
         - label: I have checked the Issues/Discussions pages to see if my issue has already been reported
+        - label: I have properly named my issue
 
   - type: dropdown
     attributes:
       label: Platform
-      description: Which platform are you compiling to/for?
+      description: Which platform are you compiling for?
       options:
        - Web/HTML5
-       - Desktop
+       - Desktop (Windows)
+       - Desktop (Mac)
+       - Desktop (Linux)
        - Other
     validations:
       required: true
@@ -32,16 +36,24 @@ body:
 
   - type: markdown
     attributes:
-      value: "## Describe your compiling error."
+      value: "## Describe your compiling issue."
 
   - type: markdown
     attributes:
       value: "### Please do not report issues from other engines. These must be reported in their respective repositories."
 
   - type: textarea
     attributes:
-      label: Description (include any images, videos, errors of terminal or console, error logs)
-      description: Provide as much detail as you can. The better others understand your issue, the more they can help you!  
-      placeholder: Describe your issue here...
+      label: Console Output
+      description: Paste any errors or warnings from the console here.
+      placeholder: Paste output here...
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Context
+      description: Provide as much detail as you can. Did you modify any code? Provide any relevant images or videos.
+      placeholder: Describe the context here...
     validations:
       required: true
diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml
@@ -8,8 +8,9 @@ body:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your issue being addressed!
       options:
-        - label: I have properly named my issue
+        - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050)
         - label: I have checked the Issues/Discussions pages to see if my issue has already been reported
+        - label: I have properly named my issue
 
   - type: dropdown
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml
@@ -8,8 +8,9 @@ body:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your suggestion being considered!
       options:
-        - label: I have properly named my enhancement
+        - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050)
         - label: I have checked the Issues/Discussions pages to see if my enhancement has already been suggested
+        - label: I have properly named my enhancement
 
   - type: textarea
     attributes: