Creating new tickets

The following is lifted from the  Mozilla Bug Writing Guidelines.

We expect that you will quickly enter new hardware and software problems you encounter, so that the problems can be tracked and resolved. Please include the software build and firmware version you are using -- displayed at power on time if the system has a developer key, or available from the home view in Joyride/Update.1 software. is the firmware version--the operating system build number--which is displayed at the end of the boot process--and the serial number of your machine--found under the battery; this will help us analyze your problem and resolve it.

Getting Help

If you need help with OLPC software (for example with Sugar or a particular activity), use one of the available support options. Do not edit this page.

If you're new to OLPC QA, you may want to try getting help from the more experienced contributors. See  the many support possibilities available.

Principles

Effective bug reports are the most likely to be fixed. These guidelines explain how to write such reports.

  • Be precise
  • Be clear - explain it so others can reproduce the bug
  • One bug per report
  • No bug is too trivial to report - small bugs may hide big bugs
  • Clearly separate fact from speculation

Preliminaries

  1. Reproduce your bug using a recent build of the software, to see whether it has already been fixed.
  2. Search Trac, to see whether your bug has already been reported.

Reporting a New Bug

If you have reproduced the bug in a recent build and noone else appears to have reported it, then:

  1. Choose "New Ticket" (that form incorporates parts of these guidelines)
  2. Select the product in which you've found the bug
  3. Fill out the form. Here is some help understanding it:

Summary: How would you describe the bug, in approximately 60 or fewer characters?

A good summary should quickly and uniquely identify a bug report. It should explain the problem, not your suggested solution.

  • Good: "Canceling a File Copy dialog crashes File Manager"
  • Bad: "Software crashes"
  • Bad: "Browser should work with my web site"

Description: The details of your problem report, including:

Overview: More detailed restatement of summary.

Example: Drag-selecting any page crashes builds in the NSGetFactory function.

Steps to Reproduce: Minimized, easy-to-follow steps that will trigger the bug. Include any special setup steps.

Example:

  1. View any web page. (I used the default sample page, resource:/res/samples/test0.html)
  1. Drag-select the page. (Specifically, while holding down the mouse button, drag the mouse pointer downwards from any point in the browser's content region to the bottom of the browser's content region.)

Actual Results: What the application did after performing the above steps.

The application crashed.

Expected Results: What the application should have done, were the bug not present.

The window should scroll downwards. Scrolled content should be selected. (Or, at least, the application should not crash.)

Build Date & Platform: Date and platform of the build in which you first encountered the bug.

Component: In which sub-part of the software does it exist (if you know; if not, leave alone.

This field is required. Click the word "Component" to see a description of each component. If none seems appropriate, look for a "General" component.

The most common options are provided as form entries.

Additional Builds and Platforms: Whether or not the bug takes place on other platforms, if you know.

Additional Information: Any other useful information.

For crashing bugs:

Please provide logs attached to the report whenever possible.

Date/Time: 2006-12-26 12:15:20.089 -0500 OS Version: 10.4.8 (Build 8L2127) Report Version: 4

Activity: Browser

Version: 2.0.0.1 (2.0.0.1)

Add an attachment: You can attach relevant files to a bug report. Debugging information more than 20 lines long should be supplied this way. Also, if you have an HTML file that demonstrates the bug, you should attach that. You can only attach one file during initial submission so if your demonstration needs more, revisit the newly filed bug to do this part. Attach any subsidiary files (such as images) first and then edit the HTML file to point to the new URLs of the attached files before uploading, so the demo is self-contained. Ask before attaching more than five files.

Double-check your report for errors and omissions, then press "Commit". Your bug report will now be in the OLPC database.

Interoperability reports

If you have problems communicating with other hardware, or you suspect the OLPC is causing trouble in a network environment, it is vital you try to gather as much information as possible about the network environment, including:

  • Device manufacturer
  • Device model
  • Software/firmware versions
  • How the network is configured
  • anything else that might be relevant.

Pasting conversations

If you're pasting conversations from the mailing list into a ticket, please do it as in the following example from #60:

'''David Woodhouse:''' Do we also have some attempt at a resume-from-RAM path?

'''Jim Gettys:''' Not yet; Mitch will work on this right after Cafe' bringup.

The triple quotes are bold, and aligning the text as above makes the tickets look nice.

Code snippets

When you need to paste code snippets or debug output, use this syntax:

{{{
code snippet
}}}

That will preserve full formatting.

Referring to other bugs

To link to another bug, e.g. bug 1:

Replica
#1

This will get auto-linkified to bug 1, like so: #1. When bug 1 gets fixed, the previous link will automatically have strike-through text on it.

Original document information

  • Author(s): Gervase Markham, based on an original by Eli Goldberg
  • Other Contributors: Claudius Gayle, Jan Leger, Felix Miata, Peter Mock, Chris Pratt, Chris Yeh, and others.
  • OLPC Modifications: Jim Gettys