Skip to content

What happens when I find a bug or issue?

ronniebrash edited this page Dec 3, 2015 · 7 revisions

So, you think you may have a legitimate issue or bug - great! But before yelling that you found a bug, please take into the account the following as part of the procedure to verify that your 'bug' is actually a bug and that it is repeatable. Just because you found it, doesn't mean that it actually is!

Verification and Documentation

Before filing a bug through our issue tracker, please perform the following:

  1. Record all of the steps taken from start to finish which caused the bug
  2. Is the bug limited to a single package? If yes, then clean, and build just the package in question using a single core (no -j option in the make command)
  3. Pull a second instance of the IntelliPi repo, update and install all feeds and rebuild - it may be a temporary issue
  4. Verify that it is not your system which has the issue or is limited to its custom configuration (networking being one of these)
  5. Is it hardware related? Does your RaspberryPi boot normally? Does your USB Bluetooth dongle work? Does your MUSE have enough battery?

If all of the above are sufficiently satisfied and you have no doubt that this is a bug - please continue onto the following section:

Filling the actual report

To file the bug, please use this format:

  1. Problem: accompanied by a simple sentence or two describing your issue
  2. What occurred: accompanied by error messages etc... if possible
  3. Reproducible steps: the EXACT steps to duplicate your issue including offending code
  4. Your system configuration: What is your OS? 32bit/64bit? and/or relevant details

If you are using an unsupported package, or custom home-brewed code - please troubleshoot first and update us if it is important to the IntelliPi project; our time and resources are limited as an organization.

If your issue has related information, or you have the 'fix' or a patch, please provide a patch using this format.