added issue templates

2026-04-29 02:31:13 +00:00 · 2024-01-03 13:49:05 +01:00
parent fcbfbb335b
commit 695ee5f458
2 changed files with 169 additions and 0 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,78 @@
+name: Bug Report 🐛
+description: Report something that's not working the intended way. Support requests for external programs (reverse proxies, 3rd party servers, other peoples' forks) will be refused!
+title: '[BUG] <title>'
+labels: ['🐛 Bug']
+body:
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Environment
+      description: What OS are you running the file from?
+      options:
+        - Windows 
+        - Linux
+        - Android (Termux)
+        - Mac
+    validations:
+      required: true
+
+  - type: input
+    id: system
+    attributes:
+      label: System
+      description: >-
+        Specify your OS/Distro version and/or Docker version.
+        For Windows:
+        - Press WINDOWS KEY + R.
+        - Type `winver` and press Enter.
+        For Linux:
+        - Open a terminal.
+        - Run one of the following commands based on your distribution:
+          - For Ubuntu/Debian: `lsb_release -a`
+          - For CentOS/Fedora: `cat /etc/os-release`
+          - For others: Check your distribution's documentation.
+        For macOS:
+        - Click on the Apple logo in the top-left corner.
+        - Select "About This Mac" to see the macOS version.
+      placeholder:
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: Describe the problem
+      description: Please describe exactly what is not working, include the steps to reproduce, actual result and expected result
+      placeholder: When doing ABC then DEF, I expect to see XYZ, but I actually see ZYX
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional info
+      description: Logs? Screenshots? Yes, please.
+      placeholder: If the issue happens during build-time, include terminal logs. For run-time errors, include browser logs which you can view in the Dev Tools (F12), under the Console tab. Take care to blank out any personal info.
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: check-check-check
+    attributes:
+      label: Please tick the boxes
+      description: Before submitting, please ensure that
+      options:
+        - label: You have explained the issue clearly, and included all relevant info
+          required: true
+        - label: You've checked that this [issue hasn't already been raised](https://github.com/SillyTavern/SillyTavern-Launcher/issues?q=is%3Aissue)
+          required: true
+        - label: You've checked the [docs](https://docs.sillytavern.app/) ![important](https://img.shields.io/badge/Important!-F6094E)
+          required: true
+
+  - type: markdown
+    attributes:
+      value: |-
+        ## Thanks 🙏
+        Thank you for raising this ticket - in doing so you are helping to make SillyTavern-Launcher better for everyone.
+    validations:
+      required: false
--- a/.github/ISSUE_TEMPLATE/feature-request.yml
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,91 @@
+name: Feature Request ✨
+description: Suggest an idea for future development of this project
+title: '[FEATURE_REQUEST] <title>'
+labels: ['🦄 Feature Request']
+
+body:
+
+  # Field 1 - Did the user searched for similar requests
+  - type: dropdown
+    id: similarRequest
+    attributes:
+      label: Have you searched for similar requests?
+      description:
+      options:
+        - 'No'
+        - 'Yes'
+    validations:
+      required: false
+
+  # Field 2 - Is it bug-related
+  - type: textarea
+    id: issue
+    attributes:
+      label: Is your feature request related to a problem? If so, please describe.
+      description:
+      placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: false
+
+  # Field 3 - Describe feature
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      placeholder: An outline of how you would like this to be implemented, include as much details as possible 
+    validations:
+      required: true
+
+  # Field 4 - Describe alternatives
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      placeholder: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+
+  # Field 5 - Additional context
+  - type: textarea
+    id: addcontext
+    attributes:
+      label: Additional context
+      placeholder: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
+
+  # Field 6 - Priority
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority
+      description: How urgent is the development of this feature
+      options:
+        - Low (Nice-to-have)
+        - Medium (Would be very useful)
+        - High (The app does not function without it)
+    validations:
+      required: true
+
+  # Field 7 - Can the user implement
+  - type: dropdown
+    id: canImplement
+    attributes:
+      label: Is this something you would be keen to implement?
+      description: Are you raising this ticket in order to get an issue number for your PR?
+      options:
+        - 'No'
+        - 'Maybe'
+        - 'Yes!'
+    validations:
+      required: false
+
+  # Final text
+  - type: markdown
+    attributes:
+      value: |-
+        ## Thanks 🙏
+        Thank you for your feature suggestion.
+        Please note that there is no guarantee that your idea will be implemented.
+    validations:
+      required: false