Bug Tutorial

This is the place for information on how to write good bug reports. Good bug reports get bugs fixed faster, so we strongly encourage you to study the information below to make sure your bug is fixed.

Good bug reports can take some time to research and write up, so to minimize the amount of time you spend posting bugs that have already been found, please check the Hot Issues page regularly. Here we will try to keep a current list of known bugs so you do not waste time researching them again.

What is expected from bug reports.

Bug reports contain most if not all of the following items.

A one-line description of the problem.

A short one sentence description of the bug helps us to know at a glance what the bug is.

Examples:

How it happened and what I expected.

The steps necessary to reproduce the bug are very important. They allow us to quickly see the bug and more importantly, see the sequence of events leading up to the bug. Many times the fix for the bug will come from one of these lead up events.

When trying to reproduce a bug, try to find the simplest, shortest, and most general conditions that will cause the bug to happen. If possible, try to find alternative methods as well, or note methods that do not cause the bug, but seem similar enough that they should.

Example:

  1. Log into the Zone and click "Upgrade software."
  2. Change the path to a Zip drive (H:)
  3. Click the "Complete Install" option.

The result of all the steps listed to reproduce the bug should be listed as well. Many times this will be a restatement of the title, but add some finality to the repro steps.

Example:

  1. Log into the Zone and click "Upgrade software."
  2. Change the path to a Zip drive (H:)
  3. Click the "Complete Install" option.

The expected result is the result that you would like to see.

Example:

Category

The bug reporting page has a section at the top that asks you to select a statement that best describes the report. This field is very important is directing the bug to the correct people.

Please follow the guidelines below to ensure your bug is sent to the correct group.

Categories:

Connection information and computer configuration

This type of information is nice for us to have so that we can take into consideration your machines configuration.

Examples:

Additional comments

This area gives you a place to state your concerns about the bug and provide more details that you feel did not fit into the categories above.

Examples: