Latest revision as of 02:24, 22 February 2023

Development

Troubleshooting

HOW-TO:Submit a bug report

Introduction

So, you think you've found a bug and not sure how to report it?

Kodi accepts bug reports on both the Kodi Forum and Github Issue reports

Check for existing reports

Duplicate bug reports only clutter the communications channels with the developers. Before posting your bug report, it is important to ensure that you have not been beaten to it.

If you find a forum thread or a Github issue report, please read through it. It may provide a solution to the issue, if not then add any new information that you can provide to describe the issue.

Reporting a bug

Once you have confirmed there are no other similar reports, it is time to open a dialog with the community.

Where to report the issue:

Forum

If you are uncertain whether it is a bug - maybe it is a problem with your music or video file, maybe a problem with your hardware, or you simply don't know if it is normal behaviour - then start on the Kodi Forum.

Please provide the supporting evidence described below.

Github

For the more experienced user and if you are absolutely certain it is a bug then report the issue on our Github Tracker.

If you report here, you are required to fill in the template. If you choose to ignore the template, or delete it, then your report will be closed. Ensure you follow the template.

Please provide the supporting evidence described below.

Do not use Github for support, or disguising a support request as a bug. These will be immediately closed and ignored. Use the forum for support.

Supporting evidence

Regardless of where you post your report, if you expect someone to take interest in it, they will expect details from you. Don't forget, we're doing this in our free time, too!

Post as much details as you can upfront. It becomes very frustrating when we are drip-fed information.

Information we need:

Clearly describe your setup including hardware, operating system, connections etc.
Clearly describe the problem.
Clearly outline the steps to replicate the problem.
Provide supporting evidence, such as:
- A debug log that captures the problem. Don't paste logs directly into the forum post or github report. Use Kodi Paste to submit logs and provide the link.
- If the problem is visible on screen, then provide screenshots so we can clearly see the problem
- If you have the time, a short video can also be very helpful.
- If it is an issue with a particular type of file, then a sample of the file will be helpful also.

We need as much information as possible, so we can reliably replicate the issue you are experiencing.

Not a bug

Not every problem you experience will be classified as a bug. Some reasons why...

Your hardware is too old, or may be a very cheap Android box with a hacked Android OS
You are using an old version of Kodi. Only the current stable release and the current master development branch are supported.
What you are experiencing is intended behaviour.

@@ Line 1: / Line 1: @@
-'''IMPORTANT!'''
+{{mininav| [[Development]] {{l2| [[Troubleshooting]] }} }}
-# The normal XBMC log '''IS NOT''' a debug log, to enable debug logging press X+Y during startup or toggle it on in [[System Settings#Hardware|System Settings]].  The log can be found in the same place as the XBMC executable.
-# Please do not paste logs to the XBMC forums, use a specially designed place like [http://pastebin.ca/ pastebin.ca] instead and link to it.
-==How to submit a bug report==
-# First check whether or not there's been a bug reported before, as your bug may already have been fixed or is in the process of being fixed. Search on [http://trac.xbmc.org/ trac] to see whether there's a similar bug filed, and add your experiences to the bug report if it is. You may also try searching in the forums to see whether others are having the same problems.<br><br>
-# If you're not sure whether it is a legitimate bug, please post on the forums and give as much information as you can, including a debug log.<br><br>
-# If you're sure it's a bug (or it has been confirmed by others in step 2) then please post a bug report on trac. The following information is essential:
-## Information as to which platform and version (SVN revision) you are running.
-## Clear steps as to how one can reproduce the problem (very few bugs are truly "random", and getting it reproducible is 90% on the way to fixing it).
-## A full _debug log_ of when the error occurs.
-## Anything else that may be of assistance to developers (eg screenshots, the skin you are using if not the default PMIII and so on).<br><br>
-# Make sure you follow up the bug report with any information that is requested by a developer.
-[[category:How To|Submit a Proper Bug Report]]
+__TOC__
-[[category:Inner Workings]]
-[[Category:To-Do]]
+= Introduction =
+So, you think you've found a bug and not sure how to report it?
+{{kodi}} accepts bug reports on both the '''[http://forum.kodi.tv Kodi Forum]''' and '''[https://github.com/xbmc/xbmc/issues Github Issue reports]'''
+= Check for existing reports =
+Duplicate bug reports only clutter the communications channels with the developers. Before posting your bug report, it is important to ensure that you have not been beaten to it.
+If you find a forum thread or a Github issue report, please read through it. It may provide a solution to the issue, if not then add any new information that you can provide to describe the issue.
+= Reporting a bug =
+Once you have confirmed there are no other similar reports, it is time to open a dialog with the community.
+Where to report the issue:
+==== Forum ====
+If you are uncertain whether it is a bug - maybe it is a problem with your music or video file, maybe a problem with your hardware, or you simply don't know if it is normal behaviour - then start on the '''[http://forum.kodi.tv Kodi Forum]'''.
+Please provide the supporting evidence described below.
+==== Github ====
+For the more experienced user and if you are absolutely certain it is a bug then report the issue on our '''[https://github.com/xbmc/xbmc/issues Github Tracker]'''.
+If you report here, you are required to fill in the template. If you choose to ignore the template, or delete it, then your report will be closed. '''Ensure you follow the template'''.
+Please provide the supporting evidence described below.
+Do not use Github for support, or disguising a support request as a bug. These will be immediately closed and ignored. Use the forum for support.
+= Supporting evidence =
+Regardless of where you post your report, if you expect someone to take interest in it, they will expect details from you. Don't forget, we're doing this in our free time, too!
+Post as much details as you can upfront. It becomes very frustrating when we are drip-fed information.
+Information we need:
+* Clearly describe your setup including hardware, operating system, connections etc.
+* Clearly describe the problem.
+* Clearly outline the steps to replicate the problem.
+* Provide supporting evidence, such as:
+** A '''[[Log file|debug log]]''' that captures the problem. Don't paste logs directly into the forum post or github report. Use '''[https://paste.kodi.tv Kodi Paste]''' to submit logs and provide the link.
+** If the problem is visible on screen, then provide '''[[Settings/System/Logging#Screenshot_folder|screenshots]]''' so we can clearly see the problem
+** If you have the time, a short video can also be very helpful.
+** If it is an issue with a particular type of file, then a sample of the file will be helpful also.
+We need as much information as possible, so we can reliably replicate the issue you are experiencing.
+= Not a bug =
+Not every problem you experience will be classified as a bug. Some reasons why...
+* Your hardware is too old, or may be a very cheap Android box with a hacked Android OS
+* You are using an old version of {{kodi}}. Only the current stable release and the current master development branch are supported.
+* What you are experiencing is intended behaviour.
+= See also =
+* [[Log file]]
+* [[Bug tracker]]
+* [[Troubleshooting]]
+{{top}}
+{{updated|20}}
+[[Category:How-to]]
+[[Category:Development]]
+[[Category:Troubleshooting]]

HOW-TO:Submit a bug report: Difference between revisions