Skip to content

Commit

Permalink
Merge pull request #3970 from knighthat/new-bug-issue-template
Browse files Browse the repository at this point in the history
New issue template
  • Loading branch information
fast4x authored Oct 13, 2024
2 parents bef1d51 + 0312ba6 commit dd131ff
Showing 1 changed file with 122 additions and 58 deletions.
180 changes: 122 additions & 58 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -1,86 +1,150 @@
name: 🐛 Bug report
description: Something isn't working, uh?
title: Short and concise description of your bug
labels: [bug]
body:
- type: markdown
attributes:
value: |
## ⚠️ Make sure you are able to reproduce the bug with the [latest version](https://github.com/fast4x/rimusic/releases/latest).
## ⚠️ Make sure there is no issue about this bug already.
value: >-
# Please complete the form to the best of your ability
- type: textarea
id: reproduce-steps
attributes:
label: Steps to reproduce the bug
description: What did you do for the bug to show up?
placeholder: |
Example:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: expected-behavior
> Indepth details provide us foundation to fix your problem as fast as
possible
<h3 align="center">Required fields are marked with <b>*</b></h3>
- type: input
id: bug_occurs_in_version
attributes:
label: Expected behavior
placeholder: |
Example:
"This should happen..."
label: Version of RiMusic
description: >-
Before we start, please specify which version of RiMusic you were using
when the bug occurs.
placeholder: 0.6.56 - customVersion
validations:
required: true
- type: markdown
attributes:
value: >-
## If you were using **_official release versions_**
- type: textarea
id: actual-behavior
Please download and install [**latest
build**](https://github.com/fast4x/RiMusic/releases/tag/custom-version)
from our Github page.
After the installation, try and reproduce the bug again.\
If problem goes away, it's probably fixed at some point and is now
waiting to be released officially.\
There's no need to open another issue.
## If you were using latest **_custom version build_**
Please **UNINSTALL** this build and install previous build and confirm
that the problem persists.
Proceed and fill out the form
- type: dropdown
id: android_version
attributes:
label: Actual behavior
placeholder: |
Example:
"This happened instead..."
label: Android version
description: What version of Android is your phone
options:
- '7.0'
- 7.1 - 7.1.2
- '8.0'
- '8.1'
- '9'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
validations:
required: true

- type: textarea
id: sreen-media
- type: checkboxes
id: verify_steps
attributes:
label: 'I''ve done these:'
description: >-
please make sure you've done all of these steps before submitting an
issue
options:
- label: Uninstall old build before installing a new one
required: true
- label: Checked opening issues about my similar problem
required: true
- type: markdown
attributes:
label: Screenshots/Screen recordings
description: |
A picture or video helps us understand the bug more.
value: >-
# Real questions
Alright, now we've already applied some of the most common
troubleshooting steps.
Next step is to fill out the description of the bug.
Information such as:
* Steps to duplicate the problem
You can upload them directly in the text box.
* How you expect it to be
* What more can you tell us
> These questions are really essential, the more you provide, the faster
we can pin point the source of error, the faster we can patch it.
- type: textarea
id: logs
attributes:
label: Logs
description: |
If your bug includes a crash, please use `adb logcat` or other ways to provide logs.
- type: input
id: rimusic-version
id: steps_to_reproduce
attributes:
label: RiMusic version
placeholder: |
Example: "0.1.5"
label: Tell us how you trigger this bug
description: 'Each step should be on its own line. You can use simple sentences like:'
value: |-
1. Open RiMusic
2. Click on A
3. Click on B
4. Boom! Crash happens
validations:
required: true

- type: input
id: android-version
id: expected_behavior
attributes:
label: Android version
description: |
You can find this somewhere in your Android settings.
placeholder: |
Example: "Android 12"
label: What was your expectation?
description: What did you expect after completing those steps
placeholder: I clicked on next so obviously it plays random. DUH!!
validations:
required: true

- type: textarea
id: additional-information
id: additional_information
attributes:
label: What more can you tell us? (Optional)
description: >-
Please let me know what more you can provide in case other fields didn't
let you fill in
placeholder: >-
I clicked on this, then uhhh, screen flickers, sound tears, and BOOM!
app crashed.
- type: textarea
id: app_logs
attributes:
label: Logs (Optional)
description: >-
If you can still access app logs, please please please, copy it and
paste it here.
- type: markdown
attributes:
label: Additional information
placeholder: |
Additional details and attachments.
value: >-
This template was generated with [Issue Forms
Creator](https://issue-forms-creator.netlify.app)

0 comments on commit dd131ff

Please sign in to comment.