Improve the issue templates

Should be more useable and generally better
This commit is contained in:
RaptaG 2023-03-09 18:31:22 +02:00 committed by GitHub
parent 328f369777
commit 69734143b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 38 additions and 77 deletions

View File

@ -1,94 +1,71 @@
name: 🐛 Bug
description: Report a bug or incorrect behavior
title: "[Bug] <title>"
description: Report a bug or an incorrect behavior
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: Type 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
description: Steps to reproduce the behavior.
label: Steps to reproduce
description: Steps to reproduce the issue. A not well written description might delay the resolve of it.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
1. I opened the app
2. I did this
3. And that
4. Then this happened
validations:
required: false
required: true
- type: input
attributes:
label: Spotube Version
description: In which version of Spotube did you encounter this bug?
placeholder: e.g. v2.3.0
- type: dropdown
attributes:
attributes:
label: Operating System
description: In which OS you're experiencing the bug?
multiple: true
options:
- "Android"
- "Linux"
- "Windows"
- "Mac OS"
description: The OS in which you used Spotube to face the issue.
placeholder: Android, Linux, macOS or Windows? Make sure to include the version too.
validations:
required: true
- type: input
attributes:
label: Linux Distribution (if applicable)
description: Tell us in what Linux Distribution you're experiencing the bug.
placeholder: Arch Linux
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
label: Spotube version
description: In which version of Spotube did you encounter this bug?
placeholder: (e.g.) v2.7.0
- type: dropdown
attributes:
label: Installation Source
description: How did you install Spotube?
label: Installation source
description: Where did you install Spotube from?
multiple: true
options:
- "Official Website (spotube.netlify.app)"
- "Github Release (Binary)"
- "Github Actions (Nightly Binary)"
- "Website (spotube.netlify.app)"
- "GitHub Releases (Binary)"
- "GitHub Actions (Nightly Binary)"
- "F-Droid (Android)"
- "Arch User Repository (AUR)"
- "Flathub (Flatpak)"
- "FlatHub (Flatpak)"
- "chocolatey (Windows)"
- "WinGet (Windows)"
- "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 add or include?
validations:
required: false

View File

@ -1,53 +1,37 @@
name: ✨ New Feature
assignees:
- KRTirtho
description: Suggest an idea
title: "[Feature] <title>"
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
description: Tell us about your solution
label: Suggested 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
description: Provide us with some useful resources/references which will help us implement your solution.
label: Useful resources
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 add or include?
validations:
required: false