Skip to content

Report a problem

Jump to bottom
AF-1 edited this page Feb 29, 2024 · 11 revisions

Checklist


❗️ Please take a quick look at this checklist to eliminate common causes of LMS problems. Thank you.


Where to report problems

You can report your problem on GitHub or (in the support thread for the plugin/applet) on the LMS forum
using the problem report template below for the LMS forum or the Issue Report template on GitHub.

Regardless, please provide as much information as possible in your problem report. Being too verbose is not a bad thing here.

  • GitHub

    Each GitHub repository has a section where issues (i.e. problems) can be added, discussed, categorized, and fixed. Users can search for (fixed) issues and track the progress of the issue fix using labels.

    If you decide to create a new issue on GitHub, ➡️ use the Issue Report template ⬅️❗️ in the issue section of the plugin's GitHub repository.

  • LMS forum

    If you prefer to post your problem report on the LMS forum, ️️please
    ➡️ stick to the problem report template below ⬅️❗️ to include all required information.



🔴 Problem report template (LMS forum) 🔴

What to include in a problem report


DESCRIBE THE BUG

A clear and concise description of what the bug is.



TO REPRODUCE

Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error



EXPECTED BEHAVIOR

A clear and concise description of what you expected to happen.



VERSION INFO

  • LMS version:
  • OS (version):
  • Plugin version:
  • Web skin/controller: Examples: LMS Default, Material, jivelite (= piCorePlayer, SqueezePlay, Touch, Radio)
  • Browser (version):

If the problem occurs with a specific web skin/controller (e.g. Material), please check whether it also occurs when using other web skins/controllers (e.g. LMS default skin).



LOG EXCERPT

  • 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.

  • Alternatively, attach the complete LMS server log file and don't forget to add the time stamp of when the problem occurred.



SCREENSHOTS

If applicable, add screenshots to help explain your problem.



OTHER FILES

If the issue involves files created by a plugin, please attach those files as well.
Example: sql and xml files created by the Dynamic Playlist Creator plugin.



Clone this wiki locally