Skip to content

Commit

Permalink
update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
AF-1 committed Dec 16, 2024
1 parent bdca822 commit d2c192e
Show file tree
Hide file tree
Showing 4 changed files with 237 additions and 80 deletions.
168 changes: 168 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
name: 🐞 Bug
description: File a bug report
title: "[BUG] your title here"
labels: ["bug: bug suspected"]
assignees:
- AF-1
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue (open or closed) already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: markdown
attributes:
value: "<br><br>"
- type: checkboxes
attributes:
label: Check common causes of LMS (plugin) problems
description: Please take a quick look at [**this checklist**](https://github.com/AF-1/sobras/wiki/Checklist-to-eliminate-common-causes-of-LMS-(plugin)-problems) to eliminate common causes of LMS (plugin) problems.
options:
- label: The list has no fix for my issue
required: true
- type: markdown
attributes:
value: "<br><br>"
- type: textarea
attributes:
label: What happened?
description: A concise description of what you're experiencing
validations:
required: true
- type: markdown
attributes:
value: "<br><br>"
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen
validations:
required: true
- type: markdown
attributes:
value: "<br><br>"
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error...
validations:
required: true
- type: markdown
attributes:
value: "<br><br>"
- type: input
attributes:
label: LMS version
description: What version of LMS are you running?
placeholder: "Example: 9.0.1"
validations:
required: true
- type: markdown
attributes:
value: "<br>"
- type: input
attributes:
label: Plugin version
description: What version of the plugin are you running?
placeholder: "Example: 1.0.3"
validations:
required: true
- type: markdown
attributes:
value: "<br>"
- type: input
attributes:
label: "Your OS (incl. version)"
description: What OS (incl. version) are you running?
placeholder: "Example: macOS 15.1.1"
validations:
required: true
- type: markdown
attributes:
value: "<br>"
- type: dropdown
attributes:
label: "What web skins / controllers are you seeing the problem with?"
description: multiple selection possible
multiple: true
options:
- Material
- Logic Teal
- Default skin
- Classic skin
- jivelite (piCorePlayer, SqueezePlay, Touch, Radio)
- not applicable
default: 0
validations:
required: true
- type: markdown
attributes:
value: "<br>"
- type: dropdown
attributes:
label: What browsers are you seeing the problem on?
description: Multiple selection possible. If your browser is not listed, add the name to bug description.
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- other
- not applicable
validations:
required: true
- type: markdown
attributes:
value: "<br><br>"
- type: textarea
attributes:
label: Environment
description: |
Go to *LMS settings > Information* and copy/paste the information for *Lyrion Music Server Status* and *Perl and Module Versions* here.
And a **list of installed plugins** (incl. version numbers).
placeholder: |
Lyrion Music Server Status: …
Perl and Module Versions: …
List of installed plugins: …
render: markdown
validations:
required: false
- type: markdown
attributes:
value: "<br><br>"
- type: checkboxes
attributes:
label: Is there relevant log output for this?
description: |
* Add relevant (error) messages from the **LMS server log** (file path at the bottom of *LMS settings* > *Information*). Use the **time stamps** in the log to find messages created around the time your problem occurred.
* If there are no server log error messages, set the **debug level for this plugin** to **Info** in *LMS settings* > *Advanced* > *Logging*, **reproduce the problem** and **check the server log** again. If there's still nothing, **repeat** this step with the debug level set to **Debug**.
options:
- label: I have searched the server log
required: true
- type: textarea
attributes:
label: Relevant log output
description: "Please copy and paste any relevant log output here. This will be automatically formatted into code, so no need for backticks.<br>📎 Alternatively, **attach** the complete server log **file** (see *Anything else* below)."
render: shell
- type: markdown
attributes:
value: "<br><br>"
- type: textarea
attributes:
label: Anything else?
description: |
Screenshots? Log files? Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images (screenshots) or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/02-featurerequest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: 💡 Feature request
description: Suggest an idea for this project
title: "[FEATURE REQUEST] your title here"
labels: ["bug: bug suspected"]
assignees:
- AF-1

body:
- type: textarea
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
validations:
required: false
- type: markdown
attributes:
value: "<br><br>"
- type: textarea
attributes:
label: Describe the solution / feature you'd like
description: A clear and concise description of what you want to happen
validations:
required: true
- type: markdown
attributes:
value: "<br><br>"
- type: textarea
attributes:
label: "Describe alternatives you've considered"
description: "A clear and concise description of any alternative solutions or features you've considered."
validations:
required: false
- type: markdown
attributes:
value: "<br><br>"
- type: input
attributes:
label: LMS version
description: What version of LMS are you running?
placeholder: "Example: 9.0.1"
validations:
required: true
- type: markdown
attributes:
value: "<br>"
- type: input
attributes:
label: Plugin version
description: What version of the plugin are you running?
placeholder: "Example: 1.0.3"
validations:
required: true
- type: markdown
attributes:
value: "<br><br>"
- type: textarea
attributes:
label: Anything else?
description: |
Add any other context or **screenshots** about the feature request here.
Tip: You can attach images (screenshots) or files by clicking this area to highlight it and then dragging files in.
validations:
required: false
80 changes: 0 additions & 80 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Lyrion Community Forum Support
url: https://forums.slimdevices.com/forum/user-forums/3rd-party-software/1628965-announce-dynamic-playlist-creator
about: Please ask questions that are not related to bug reports or feature requests here.

0 comments on commit d2c192e

Please sign in to comment.