Scorpio Helper: Bug writing guidelines

Home
Reporting a new Bug
Searching for reported BUGS
Bug's Life Cycle

Why You Should Read This
The Scorpio tracking system allows any reporter to report bugs of their respective projects. The more effectively a bug is reported, the more likely that a developer will fix it. By following these guidelines, you can help ensure that your bugs get fixed.

How to Write a Useful Bug Report

A useful bug report normally has two qualities:

1. Reproducible. If an engineer can't see it or conclusively prove that it exists, the engineer will probably stamp it "WORKSFORME" or "INVALID", and move on to the next bug. Every relevant detail you can provide helps.
   
2. Specific. The quicker the engineer can isolate the issue to a specific problem, the more likely it'll be expediently fixed. If you're crashing on a site, please take the time to isolate what on the page is triggering the crash, and specify the file.

How to Enter your Useful Bug Report into Scorpio:

• Before you enter your bug, you need to make sure it has not been previously reported.
• Next, be sure that you've reproduced your bug using a latest release.
• If you've discovered a new bug using a latest release, report it in Scorpio by using the following instructions .

• From the Scorpio main page (http://bugs.sanisoft.com), choose "Report Bugs".

  Now, fill out the form. Here's what it all means:
  
  Modules:Which are the directories(modules) or subdirectories (sub-modules) were the defect was found?
  Severity: How damaging is the bug?
  To determine the most appropriate severity for a particular bug, Select an option from Severity dropdown for a full explanation of bug.

  • Block: Bug prevents you from testing or developing application.
  • Crash: System crashes down.
  • Major: A major feature is broken.
  • Minor:Minor loss of function and there's an easy work arround.
  • Tweak:
  • Text:
  • Trivial:A cosmetic problem such as misspelled word or misaligned text.
  • Feature: Any enhancement or new feature.

  Reproducibility: How often the problem reproduces?

  • Always
  • Sometimes
  • Random
  • Have not tried
  • Unable to duplicate

Summary: How would you describe the bug, in approximately 60 or fewer characters?
A good summary should quickly and uniquely identify a bug report. Otherwise, developers cannot meaningfully query by bug summary, and will often fail to pay attention to your bug report when reviewing a 10 page bug list.

Defect Observed: What Defect is observed in the Product?
Please provide as detailed of a problem diagnosis in this field as possible.

Desired Results: What should be the expected result?
Specify the way ,application should work.