Skip to content

Submitting bug reports

olajep edited this page Dec 3, 2014 · 2 revisions

If you think you have found a bug in the SDK (something doesn't behave or react in the correct way), you should submit a bug report for it to the tracker which can be found here.

Note unlike bugzilla, you cannot directly upload code to bugs, please also read the Attaching Code/Logs/etc. section for more on how to do this

There is now an additional wiki page regarding the use of issue labels to categorize bugs throughout their life. It is advised that you read this extra information to understand and help with the bug fixing process.

Submitting Bugs

The following is a few points that help you create helpful bug reports which result in bugs being fixed.

  1. Search for if the bug has already been reported. If someone else has already submitted the same bug, it is more useful to comment that you also are experiencing the same issue as we then know multiple people are suffering from the same issue and that this should be focused on first.
  2. Provide a useful title. Something like "e-gcc Internal Compiler Error" is more useful than "e-gcc doesn't work". This helps us track down where we should be looking to fix the issue.
  3. Provide details. What version of the software are you using? What operating system are you using? How reproducible is the issue, does it happen every time or just occasionally? How serious is the issue, does it stop everything working or is it a minor irritation? Provide logs and program outputs where possible.
  4. Provide a test case. If you have a piece of code/etc. that always triggers this bug, submit that with the bug. Unlike bugzilla based bug trackers, you can only attach images to the GitHub issue tracker, see Attaching Code/Logs/etc. for more detail.
  5. (If possible) Submit a patch. If you have already solved an error you have found, then please submit a patch that fixes the issue. For more details on this, please read Submitting Patches.

Attaching Code/Logs/etc.

When submitting bug reports, it is often useful to submit code that triggers bug along with a log of any errors encountered etc. However, GitHub's bug tracker does not allow you to upload files other than images. As such, data to be uploaded must be put elsewhere and then linked to the bug. GitHub Gists provides one such way of doing this.

To do this, first visit the GitHub Gist website (http://gist.github.com) where you are presented with a box to paste code into. Add multiple files if required and then add a description plus filename(s) to your gist and then save it using either the "Create Secret Gist" or "Create Public Gist" button (either will work). Note that to delete your code later you must be logged into GitHub.

Once submitted, copy the URL from the "Link to this Gist" box (example: https://gist.github.com/d8dd7e2d409d9e4556d9) and paste it into your bug report as part of a comment.

You can’t perform that action at this time.