Merge pull request #435 from KRTirtho/new-templates

Improve the issue templates

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,82 +1,61 @@
 name: 🐛 Bug
-description: Report a bug or incorrect behavior
+description: Report a bug or an incorrect behavior
-title: "[Bug] <title>"
+title: "Write the title here"
 labels:
   - bug
-  - good first issue
+
-assignees:
-  - KRTirtho
 body:
   - type: checkboxes
     attributes:
       label: Is there an existing issue for this?
-      description: Please search to see if an issue already exists for the bug you encountered.
+      description: Make sure to check if this issue is a duplicate.
       options:
         - label: I have searched the existing issues
           required: true
   - type: textarea
     attributes:
       label: Current Behavior
-      description: Tell us what you're experiencing concisely.
+      description: Write what you are experiencing currently.
     validations:
       required: true
   - type: textarea
     attributes:
       label: Expected Behavior
-      description: Let us know what you expected to happen concisely.
+      description: Write what you expected to happen.
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Steps To Reproduce
+      label: Steps to reproduce
-      description: Steps to reproduce the behavior.
+      description: Steps to reproduce the issue. A not well written description might delay the resolve of it.
       placeholder: |
-        1. In this environment...
+        1. I opened the app
-        2. With this config...
+        2. I did this
-        3. Run '...'
+        3. And that
-        4. See error...
+        4. Then this happened
     validations:
-      required: false
+      required: true
   - type: input
-    attributes:
+      attributes:
-      label: Spotube Version
-      description: In which version of Spotube did you encounter this bug?
-      placeholder: e.g. v2.3.0
-  - type: dropdown
-    attributes:
       label: Operating System
-      description: In which OS you're experiencing the bug?
+      description: The OS in which you used Spotube to face the issue.
-      multiple: true
+      placeholder: Android, Linux, macOS or Windows? Make sure to include the version too.
-      options:
-        - "Android"
-        - "Linux"
-        - "Windows"
-        - "Mac OS"
     validations:
       required: true
   - type: input
     attributes:
-      label: Linux Distribution (if applicable)
+      label: Spotube version
-      description: Tell us in what Linux Distribution you're experiencing the bug.
+      description: In which version of Spotube did you encounter this bug?
-      placeholder: Arch Linux
+      placeholder: (e.g.) v2.7.0
-    validations:
-      required: false
-  - type: input
-    attributes:
-      label: Operating System Version
-      description: In which version of your OS you're experiencing the bug?
-      placeholder: e.g. Android 10
-    validations:
-      required: true
   - type: dropdown
     attributes:
-      label: Installation Source
+      label: Installation source
-      description: How did you install Spotube?
+      description: Where did you install Spotube from?
       multiple: true
       options:
-        - "Official Website (spotube.netlify.app)"
+        - "Website (spotube.netlify.app)"
-        - "Github Release (Binary)"
+        - "GitHub Releases (Binary)"
-        - "Github Actions (Nightly Binary)"
+        - "GitHub Actions (Nightly Binary)"
         - "F-Droid (Android)"
         - "Arch User Repository (AUR)"
         - "Flathub (Flatpak)"
@@ -85,10 +64,9 @@ body:
         - "Scoop (Windows)"
     validations:
       required: true
-
   - type: textarea
     attributes:
       label: Additional information
-      description: Anything else you'd like to add?
+      description: Anything else you'd like to include?
     validations:
       required: false

.github/ISSUE_TEMPLATE/new_feature.yml

@@ -1,53 +1,38 @@
 name: ✨ New Feature
-assignees:
-  - KRTirtho
 description: Suggest an idea
-title: "[Feature] <title>"
+title: "Write the title here"
 labels:
   - enhancement
-  - good first issue
 
 body:
   - type: checkboxes
     attributes:
       label: Is there an existing issue for this?
-      description: Please search to see if an issue already exists for the bug you encountered.
+      description: Make sure to check if this issue is a duplicate.
       options:
         - label: I have searched the existing issues
           required: true
-  - type: dropdown
-    attributes:
-      label: Category of the Feature
-      description: In which category you think your feature belongs to.
-      multiple: true
-      options:
-        - UI Improvements
-        - Logical Improvements
-        - More Efficiency
-        - Performance Improvements
-        - UX Improvements
-        - Code Refactor
-        - Unable to categorize
-  - type: input
-    attributes:
-      label: Credits
-      description: Who've contributed to this idea of this feature?
-    validations:
-      required: true
   - type: textarea
     attributes:
       label: Pain
       description: Explain the pain you're experiencing.
-      placeholder: e.g. I don't like that I've to do this...
+      placeholder: I don't like that I've to do this / I'd like to have that
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Suggested Solution
+      label: Suggested solution
-      description: Tell us about your solution
+      description: Tell us about a solution you can think of
+      placeholder: You could add that / change this / use that
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Useful resources/references
+      label: Useful resources
-      description: Provide us with some useful resources/references which will help us implement your solution.
+      description: Provide us with some useful resource which could help us implement your suggestion.
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: Anything else you'd like to include?
+    validations:
+      required: false