Revamp issue and PR templates (#253)

* Create config.yml Signed-off-by: naturecodevoid <44983869+naturecodevoid@users.noreply.github.com> * Delete bug_report.md Signed-off-by: naturecodevoid <44983869+naturecodevoid@users.noreply.github.com> * Create bug_report.yml Signed-off-by: naturecodevoid <44983869+naturecodevoid@users.noreply.github.com> * Create feature_request.yml Signed-off-by: naturecodevoid <44983869+naturecodevoid@users.noreply.github.com> * Create pull_request_template.md Signed-off-by: naturecodevoid <44983869+naturecodevoid@users.noreply.github.com> --------- Signed-off-by: naturecodevoid <44983869+naturecodevoid@users.noreply.github.com>
2026-02-09 06:43:25 +01:00 · 2023-02-05 21:43:44 -08:00
parent be39b6512f
commit 79d677cf3c
5 changed files with 98 additions and 34 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,34 +0,0 @@
---
-name: Bug report
-about: Create a report to help us improve
-title: "[BUG]"
-labels: bug
-assignees: ''
-
---
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Logs**
-Please send logs generated with [idevicedebug](https://github.com/libimobiledevice/libimobiledevice) or Xcode. We will close the issue if a log is missing.
-
-**iDevice (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
-
-**Additional context**
-Add any other context about the problem here.
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,40 @@
+name: Bug Report
+description: Report a bug
+title: "[BUG] "
+labels: ["bug"]
+assignees:
+  - naturecodevoid
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! Before you continue filling out the report, please **[search in GitHub Issues](https://github.com/SideStore/SideStore/issues?q=is%3Aissue+is%3Aopen) for the bug you are experiencing** in case it has already been reported.
+        
+        **Please use [Discord](https://discord.gg/RgpFBX3Q3k) or [GitHub Discussions](https://github.com/SideStore/SideStore/discussions) for support.**
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: What is the bug and how did you discover it?
+      placeholder: Please be clear and concise with your description.
+    validations:
+      required: true
+  - type: textarea
+    id: how-to-reproduce
+    attributes:
+      label: Instructions to reproduce
+      description: Please include clear and consistent instructions for reproducing the bug to make it easier for us to fix it.
+    validations:
+      required: true
+  - type: input
+    id: app-version
+    attributes:
+      label: What version of SideStore are you using?
+      description: To retrieve this, go to `Settings` in the SideStore app and scroll down to the bottom.
+    validations:
+      required: true
+  - type: textarea
+    id: other-info
+    attributes:
+      label: Other info
+      description: If you have any other comments, other info that might be useful, or if you found a workaround, please put it here.
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,10 @@
+# force issue template usage
+blank_issues_enabled: false
+
+contact_links:
+  - name: Discord
+    url: https://discord.gg/RgpFBX3Q3k
+    about: If you need support, please go here first instead of making an issue!
+  - name: GitHub Discussions
+    url: https://github.com/SideStore/SideStore/discussions
+    about: As an alternative to Discord, you can also make a new GitHub discussion.
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,33 @@
+name: Feature Request
+description: Suggest a feature
+title: "[FEATURE REQUEST] "
+labels: ["enhancement"]
+assignees:
+  - naturecodevoid
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request! Before you continue filling out the form, please **[search in GitHub Issues](https://github.com/SideStore/SideStore/issues?q=is%3Aissue+is%3Aopen) for the feature you are suggestion** in case it has already been suggested.
+        
+        **Please use [Discord](https://discord.gg/RgpFBX3Q3k) or [GitHub Discussions](https://github.com/SideStore/SideStore/discussions) for support.**
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the feature
+      description: What is the feature? How would it work?
+      placeholder: Please be clear and concise with your description.
+    validations:
+      required: true
+  - type: textarea
+    id: use-cases
+    attributes:
+      label: Use cases
+      description: Please include multiple use cases where this feature would be useful.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: If you have alternative ideas of how this feature could work, you can put them here.
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -0,0 +1,15 @@
+### Changes
+
+<!-- Fill this list with what your PR changes. Example: -->
+- Fix bug
+- Change UI for QOL
+
+<!-- If your PR is ready to be merged, you can remove this section. -->
+### Todo before merge
+
+<!-- Example: -->
+- [x] Finish UI changes
+- [ ] Test
+
+<!-- If your PR doesn't close an issue, you can remove the next line. -->
+Closes #1234