Update issue templates

microg · Nov 2, 2024 · 8a5eb30 · 8a5eb30
1 parent 4b97cbc
commit 8a5eb30
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 51 deletions.
diff --git a/.github/ISSUE_TEMPLATE/app-misbehaving.md b/.github/ISSUE_TEMPLATE/app-misbehaving.md
@@ -8,35 +8,44 @@ assignees: ''
 
 ---
 
-**Affected app**
-Name: [e.g. WhatsApp]
-Package id: [e.g. com.whatsapp]
-<!-- You can find the package id in the URL of the Play Store page, e.g. https://play.google.com/store/apps/details?id=com.whatsapp -->
+<!-- Any text like this is a comment, and will be used to explain what you should input and/or examples. -->
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## App info
+Name: <!-- [e.g. WhatsApp] -->
+Package ID: <!-- [e.g. com.whatsapp] -->
 
-**To Reproduce**
-Steps to reproduce the behavior:
+<!-- You can find the package ID in the URL of the Play Store page, e.g. https://play.google.com/store/apps/details?id=com.whatsapp -->
+<!-- Some aftermarket OSes (e.g. CalyxOS) might also show this under App Info -->
+
+## Brief description of the bug
+<!-- A clear and concise description of what the bug is. -->
+
+## Steps to reproduce
+<!-- e.g. 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.
-
-**System**
-Android Version: [e.g. 10]
-Custom ROM: [e.g. LineageOS 17.1]
-
-**microG**
-microG Core version: [e.g. 0.2.13.203915]
-microG Self-Check results: [e.g. All ticked]
-<!-- Please note that any of the self-check items not being ticked is a good indicator of microG being not properly set up. If something is not working, it might just be because of that. -->
-
-**Additional context**
-Add any other context about the problem here.
+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. -->
+
+## System Info
+<!-- e.g.
+Android version: 15
+OS: LineageOS 22 (whether it is official, unofficial, etc)
+microG version: 0.3.3.240913 (make sure all components such as Companion are updated)
+microG Self-Check: All ticked (can be found in microG Settings)
+-->
+
+Android version:
+OS:
+microG version:
+microG Self-Check:
+<!-- Missing checks in the self-check menu might be the reason why the issue is happening! -->
+
+## Additional context
+<!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -1,31 +1,44 @@
 ---
 name: Generic bug report
-about: Let us know about something not working as expected
+about: Let us know about something not working as expected with microG itself
 title: ''
 labels: bug
 assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+<!-- Any text like this is a comment, and will be used to explain what you should input and/or examples. -->
 
-**To Reproduce**
-Steps to reproduce the behavior:
+## Brief description of the bug
+<!-- A clear and concise description of what the bug is. -->
+
+## Steps to reproduce
+<!-- e.g. Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
-4. See error
+4. See error -->
+
+## Expected behaviour
+<!-- A clear and concise description of what you expected to happen. -->
+
+## Screenshots
+<!-- If applicable, add screenshots to help explain your problem. -->
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+## System Info
+<!-- e.g.
+Android version: 15
+OS: LineageOS 22 (whether it is official, unofficial, etc)
+microG version: 0.3.3.240913 (make sure all components such as Companion are updated)
+microG Self-Check: All ticked (can be found in microG Settings)
+-->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+Android version:
+OS:
+microG version:
+microG Self-Check:
+<!-- Missing checks in the self-check menu might be the reason why the issue is happening! -->
 
-**System**
-Android Version: [e.g. 10]
-Custom ROM: [e.g. LineageOS 17.1]
 
-**Additional context**
-Add any other context about the problem here.
+## Additional context
+<!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -1,20 +1,23 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
+about: Suggest an feature or idea for microG
 title: ''
 labels: enhancement
 assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!-- Any text like this is a comment, and will be used to explain what you should input and/or examples. -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+## Use case
+<!-- Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. e.g. I'm always frustrated when [...] -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+## Proposed solution
+<!-- A clear and concise description of what you want to happen. -->
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+## Alternative solutions
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+## Additional context
+<!-- Add any other context or screenshots about the feature request here. -->