Add GitHub Issue Templates

2024-06-02 19:47:51 -04:00 · 2023-08-29 16:02:28 -04:00 · 2023-08-29 16:02:28 -04:00 · c6387808c1
parent d2c5799614
commit c6387808c1
3 changed files with 149 additions and 0 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@ -0,0 +1,68 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug Report] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+  - type: markdown
+    attributes:
+      value: |
+        Do not use this GitHub form if you are using EmuDeck for Windows. Instead, join the Discord (connect your Patreon to Discord), https://discord.gg/b9F7GpXtFP, or open an issue on the EmuDeck for Windows GitHub repository, https://github.com/EmuDeck/emudeck-we to report any issues. 
+  
+  - type: checkboxes
+    id: low-effort-checks
+    attributes:
+      label: Prerequisite Steps
+      description: Please confirm that you have done the following
+      options:
+        - label: I have searched existing issues
+        - label: This issue is not a duplicate of an existing one
+        - label: I have checked the [EmuDeck Wiki](https://emudeck.github.io/)
+        - label: I have read the [Troubleshooting Page](https://emudeck.github.io/troubleshooting/steamos/) on the EmuDeck Wiki
+
+  - type: textarea
+    id: distro
+    attributes:
+      label: What distro are you running?
+      description: If you are on a Steam Deck, you are likely using SteamOS. You may also share information about the distro you are using.
+      placeholder: Distro name
+      value: SteamOS
+    validations:
+      required: true
+
+  - type: dropdown
+    id: steamos-branch
+    attributes:
+      label: Which SteamOS Branch are you using?
+      description: If you are on a Steam Deck, you may check in Game Mode. Press the STEAM button, click System, and look for the System Update Channel drop-down menu.
+      options:
+        - Stable
+        - Beta
+        - Preview
+        - Beta Candidate
+        - Main (Alpha/Live Testing Branch, not the same thing as Stable)
+        - Not Using a Steam Deck
+      default: 0
+    validations:
+      required: true
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A clear and concise description of what the bug is and if possible, the steps you used to get to the bug. If appropriate, include screenshots or videos.
+      placeholder: Include as much detail as possible. 
+      value: "A bug happened!"
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. You can find the EmuDeck log in $HOME/emudeck. For more information, see https://emudeck.github.io/troubleshooting/steamos/#how-to-get-the-emudeck-log. 
+      render: shell
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Read the Docs
+    url: https://emudeck.github.io/
+    about: Do not use GitHub Issues for support. Read the docs or join the EmuDeck Discord.
+  - name: EmuDeck Discord
+    url: https://discord.gg/b9F7GpXtFP
+    about: Do not use GitHub Issues for support. Please ask and answer questions in the Discord.
+  - name: EmuDeck for Windows
+    url: https://github.com/EmuDeck/emudeck-we
+    about: Visit the EmuDeck for Windows repository or join the Discord to report any Windows specific issues. 
--- a/.github/ISSUE_TEMPLATE/feature-request.yml
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@ -0,0 +1,70 @@
+name: Feature Request
+description: Submit a feature request
+title: "[Feature Request] "
+labels: ["feature-request"]
+body:
+  - type: checkboxes
+    id: low-effort-checks
+    attributes:
+      label: Prerequisite Steps
+      description: Please confirm that you have done the following
+      options:
+        - label: I have searched existing issues
+        - label: This issue is not a duplicate of an existing one
+        - label: I have checked the [EmuDeck Wiki](https://emudeck.github.io/)
+
+  - type: dropdown
+    id: type-of-feature
+    attributes:
+      label: Feature Request
+      description: What type of feature are you requesting?
+      options:
+        - New Emulator
+        - Steam ROM Manager Parser
+        - Emulator Configuration Feedback
+        - New Cloud Services  
+        - EmuDeck Feedback
+        - EmuDeck Application Feedback
+      default: 0
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        * New Emulator: Request an emulator to be added to EmuDeck. Make sure it runs on the Steam Deck first!
+        * Steam ROM Manager Parser: Typically used for RetroArch cores or MAME drivers. If it is a standalone emulator, use the "Standalone Emulator" option instead.
+        * Emulator Configuration Feedback: Have any feedback on how emulators are configured in EmuDeck? For example, should a setting be turned on or off in a specific emulator?
+        * New Cloud Services: Want a new cloud service to be added to EmuDeck? These specifically refer to streaming services such as Netflix or Hulu.
+        * EmuDeck Feedback: Want a new feature in EmuDeck or have any feedback on the EmuDeck suite as a whole?
+        * EmuDeck Application Feedback: Have any feedback on the EmuDeck application?
+  
+  - type: textarea
+    id: feature-request
+    attributes:
+      label: Elaborate on the feature you would like to see added to EmuDeck.
+      description: Include as much information as possible. Include links and why it would be a good addition to EmuDeck.
+      placeholder: Feature Request
+      value: Could Citra be added to EmuDeck? It's one of the best 3DS emulators. It has a Flatpak in Discover and runs great on Steam Deck. For the website, see https://citra-emu.org/. 
+    validations:
+      required: true
+
+  - type: textarea
+    id: websites
+    attributes:
+      label: Include any websites or links that may support your feature request. 
+      description: Links to the website for the feature, links that support the feature, links that show how to run the feature on Steam Deck or Linux. If it is a cloud service, make sure to include the link in this section. With cloud services, do keep in mind that some streaming services have regional specific links.
+      placeholder: Feature Request
+      value: https://citra-emu.org/ and https://flathub.org/apps/org.citra_emu.citra
+    validations:
+      required: true
+
+  - type: textarea
+    id: feature-test
+    attributes:
+      label: Does this feature work on the Steam Deck?
+      description: Have you tested this feature on the Steam Deck? If it is a new emulator, does it run well natively or through Proton? If it is configuration feedback, have you tested it thoroughly?
+      placeholder: Feature Test
+      value: Yes, I downloaded Citra from Discover and tested it on my Steam Deck. It works great!
+    validations:
+      required: false