Add issue templates (#44)

* set build type for macos only on top level * add issue templates Co-authored-by: altalk23 <student@altalk23.local>
2024-11-22 07:27:59 -05:00 · 2022-10-11 23:56:12 +03:00 · 2022-10-11 23:56:12 +03:00 · c7a7e0f128
commit c7a7e0f128
parent 09a9ebbced
6 changed files with 185 additions and 1 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@ -0,0 +1,65 @@
+name: Bug Report
+description: Report a bug where something is not working as expected, which does not crash the game.
+labels: [ "unverified", "bug" ]
+body:
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      description: The platform you were using when this bug was encountered.
+      options:
+        - "MacOS"
+        - "Windows"
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Geode Version
+      description: The version of Geode you were using when this bug was encountered. If you do not know where to find this, look for the mods listing.
+      placeholder: "Example: v0.5.4"
+    validations:
+      required: true
+  - type: textarea
+    id: mods
+    attributes:
+      label: Mods Installed
+      description: The mods and their respective versions used when this bug was encountered. If you were not using mods, please leave this field blank.
+      placeholder: "Example: geode.test v1.0.0, geode.testdep v0.1.0"
+    validations:
+      required: false
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What you expected to happen. Attach screenshots here as necessary.
+      placeholder: "Example: Expected to produce X by consuming Y."
+    validations:
+      required: true
+  - type: textarea
+    id: result
+    attributes:
+      label: Actual Behavior
+      description: What happened despite your expectations. Attach screenshots here as necessary.
+      placeholder: "Example: Produced one X but Y was not consumed."
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: How to reproduce the bug.
+      placeholder: "Example: 1) I did X..."
+    validations:
+      required: true
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: Any additional information you wish to provide. Please add anything which did not fit into the other sections here.
+      placeholder: "Example: This is likely caused by X because..."
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to fill out this bug report. 
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@ -0,0 +1,4 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord link
+    about: Find us at https://discord.gg/9e43WMKzhp
--- a/.github/ISSUE_TEMPLATE/crash-report.yml
+++ b/.github/ISSUE_TEMPLATE/crash-report.yml
@ -0,0 +1,57 @@
+name: Crash Report
+description: Report a bug that crashes the game or prevents startup.
+labels: [ "unverified", "crash" ]
+body:
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      description: The platform you were using when this bug was encountered.
+      options:
+        - "MacOS"
+        - "Windows"
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Geode Version
+      description: The version of Geode you were using when this bug was encountered. If you do not know where to find this, look for the mods listing.
+      placeholder: "Example: v0.5.4"
+    validations:
+      required: true
+  - type: textarea
+    id: mods
+    attributes:
+      label: Mods Installed
+      description: The mods and their respective versions used when this bug was encountered. If you were not using mods, please leave this field blank.
+      placeholder: "Example: geode.test v1.0.0, geode.testdep v0.1.0"
+    validations:
+      required: false
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: How to reproduce the crash.
+      placeholder: "Example: 1) I did X..."
+    validations:
+      required: true
+  - type: textarea
+    id: crash-report
+    attributes:
+      label: Crash Report
+      description: "You can find the crash report in `geode/crashlogs/`, if one was created. If you are using MacOS you can find the crash report in `Console.app` too. Additionally, please attach latest log in `geode/log/`. If either or both files do not exist, state such. Please link to a paste site with their content, such as GitHub Gists or Pastebin. **Do not paste the contents of either these files directly into the text box.**"
+      placeholder: "Example: a link to a paste site with the crash report and latest.log."
+    validations:
+      required: false
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: Any additional information you wish to provide. Please add anything which did not fit into the other sections here.
+      placeholder: "Example: This is likely caused by X because..."
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to fill out this crash report.
--- a/.github/ISSUE_TEMPLATE/feature-request.yml
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@ -0,0 +1,39 @@
+name: Request a Feature
+description: Request a new feature or a change to an existing one.
+labels: [ "feature" ]
+body:
+  - type: input
+    id: version
+    attributes:
+      label: Geode Version
+      description: The version of Geode you are using for suggesting a feature on. If you do not know where to find this, look for the mods listing.
+      placeholder: "Example: v0.5.4"
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Related Problem
+      description: If the feature you wish to change is related to a problem, please describe it. Leave this field blank if it is not related to a problem.
+      placeholder: "Example: I'm always frustrated when..."
+    validations:
+      required: false
+  - type: textarea
+    id: solution
+    attributes:
+      label: Your Solution
+      description: Describe the solution you would like to have happen.
+      placeholder: "Example: If I could..."
+    validations:
+      required: true
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: Any additional information you wish to provide. Please add anything which did not fit into the other sections here.
+      placeholder: "Example: This is likely achieveable by doing X because..."
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to fill out this feature request.
--- a/.github/ISSUE_TEMPLATE/question.yml
+++ b/.github/ISSUE_TEMPLATE/question.yml
@ -0,0 +1,19 @@
+name: Ask a Question
+description: Ask a question regarding this project.
+labels: [ "question" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        If you are in need of quick response, Discord may be a better place. We are quite active on Discord, so you may get responses quicker. 
+  - type: textarea
+    id: question
+    attributes:
+      label: Your Question
+      description: Feel free to ask any question regarding this project here.
+      placeholder: "Example: How can I...?"
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to ask me a question.
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@ -8,7 +8,7 @@ project(geode-sdk VERSION ${GEODE_VERSION} LANGUAGES CXX C)

 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
-if (APPLE)
+if (PROJECT_IS_TOP_LEVEL AND APPLE)
 	set(CMAKE_BUILD_TYPE Debug)
 endif()