Skip to content

Commit

Permalink
Improved the issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
gokadzev committed Jun 26, 2023
1 parent bce56c3 commit 8ed9554
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 25 deletions.
39 changes: 24 additions & 15 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,63 +1,72 @@
name: 🐞 Issue Report
description: Report a issue in Musify
description: Report an issue in Musify
title: "[Bug] <title>"
labels:
- bug
assignees:
- gokadzev

body:
- type: checkboxes
id: acknowledgements
attributes:
label: Acknowledgements
description: Your issue will be closed if you haven't done these steps.
description: Please make sure you have completed these steps before submitting the issue.
options:
- label: I have searched the existing issues and this is a new ticket, **NOT** a duplicate or related to another open issue.
- label: I have searched the existing issues and confirmed that this is a new issue, not a duplicate or related to another open issue.
required: true
- label: I have written a short but informative title.
required: true
- label: I have updated the app to latest version **[Latest](https://github.com/gokadzev/Musify/releases)**.
- label: I have updated the app to the latest version. You can find the latest version [here](https://github.com/gokadzev/Musify/releases).
required: true
- label: I will fill out all
- label: I will fill out all the sections in this issue report.
required: true

- type: textarea
attributes:
label: Current Behavior
description: Tell us what you're experiencing concisely.
description: Provide a concise description of what you're experiencing.
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: Let us know what you expected to happen concisely.
description: Provide a concise description of what you expected to happen.
validations:
required: true

- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
description: Describe the steps to reproduce the behavior. Please provide clear instructions.
placeholder: |
Example:
1. First step
2. Second step
3. Issue here
3. Issue occurs here
validations:
required: false

- type: input
attributes:
label: Musify Version
description: In which version of Musify did you encounter this bug?
placeholder: e.g. v3.0.0
description: Mention the version of Musify in which you encountered this bug.
placeholder: e.g., v3.0.0
validations:
required: true

- type: input
attributes:
label: Operating System Version
description: In which version of your OS you're experiencing the bug?
placeholder: e.g. Android 12
description: Mention the version of your operating system where you're experiencing the bug.
placeholder: e.g., Android 12
validations:
required: true

- type: textarea
attributes:
label: Additional information
description: Anything else you'd like to add?
label: Additional Information
description: Add any additional information or context that may be helpful in resolving the issue.
validations:
required: false
27 changes: 17 additions & 10 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ⭐ Feature request
name: ⭐ Feature Request
assignees:
- gokadzev
description: Suggest a feature to improve the app
Expand All @@ -10,14 +10,15 @@ 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: Please search to see if an issue already exists for the feature you're requesting.
options:
- label: I have searched the existing issues
- label: I have searched the existing issues and confirmed that this feature is not already requested.
required: true

- type: dropdown
attributes:
label: Category of the Feature
description: In which category you think your feature belongs to.
description: Select the category to which your feature belongs.
multiple: true
options:
- UI Improvements
Expand All @@ -27,26 +28,32 @@ body:
- UX Improvements
- Code Refactor
- Unable to categorize

- type: input
attributes:
label: Credits
description: Who've contributed to this idea of this feature?
description: Who contributed to the 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...
description: Describe the pain or problem you're experiencing that this feature would address.
placeholder: e.g., I don't like that I have to do...
validations:
required: true

- type: textarea
attributes:
label: Suggested Solution
description: Tell us about your solution
description: Describe your suggested solution for the feature.
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/References
description: Provide any useful resources or references that can help in implementing your suggested solution.
validations:
required: false

0 comments on commit 8ed9554

Please sign in to comment.