HowTo Bugtracker

From SONIVIS:Wiki

Jump to: navigation, search

These guidelines are a general tutorial to teach novice and intermediate bug reporters how to compose effective bug reports.

Contents

How to Register

Please go to our bugtracking system, then please click on Register
Fill out all required fields (indicated by red bars)
... now you are registered but you have to wait until one of our administrators assigns the SONIVIS project to your account. This should last at most 24h.

How to Report Bugs Effectively - Hints [1]

  1. Be specific: If you can do the same thing two different ways, state which one you used. "I selected Load" might mean "I clicked on Load" or "I pressed Alt-L". Say which you did. Sometimes it matters.
  2. Be verbose: Give more information rather than less. If you say too much, the programmer can ignore some of it. If you say too little, they have to come back and ask more questions. }
  3. Be careful of pronouns: Don't use words like "it", or references like "the window", when it's unclear what they mean. Consider this: "I started FooApp. It put up a warning window. I tried to close it and it crashed." It isn't clear what the user tried to close. Instead, you could say "I started FooApp, which put up a warning window. I tried to close the warning window, and FooApp crashed." This is longer and more repetitive, but also clearer and less easy to misunderstand.
  4. Read what you wrote: Read the report back to yourself, and see if you think it's clear. If you have listed a sequence of actions which should produce the failure, try following them yourself, to see if you missed a step.


How to Enter your Useful Bug Report into CodeBeamer

Before you enter your bug, use CodeBeamer's quick search or sorting function to determine whether the defect you've discovered is a known, already-reported bug. If your bug is the 37th duplicate of a known issue, you're more likely to annoy the engineer.

Next, be sure to reproduce your bug using a recent build. Engineers tend to be most interested in problems affecting the code base that they're actively working on. After all, the bug you're reporting may already be fixed.

If you've discovered a new bug using a current build, report it in CodeBeamer:

  1. From SONIVIS hompepage, choose "Bugtracker".
  2. Enter your user name (e-mail address), password, and press the "Login" button. (If you don't yet have an account, and press the "Register" button instead and follow the instructions.)
  3. tdc


Labels

Labels are used to help the SONIVIS:Team categorize and prioritize the bug reports that are coming in. Each report can (and should) have multiple labels.

Label Allowed values Description
Tracker Bug
Idea
Requirement
Task
The issue type. An issue can only have one type.
Status New
Unconfirmed
Verified
Resolved
Reopened
Closed
BugLife Cycle
Priority Blocker
Enhancement
Minor
Priority is based on the importance and urgency of resolving the bug/task.
Assigned to SONIVIS developers Assign the bug to a particular person (an email notification is sent)
Estimated Hours Numbers between 0.1 and ? Normally we use the Fibonacci number, because as higher the development effort for a certain task as less is the ability to estimate the effort. Therefore the each subsequent number is equal to the sum of the previous two numbers of the sequence itself.
Spent Hours Numbers between 0.1 and ? This field we added to have a control about our estimations.., at the moment rarely used.
Severity Blocker
Enhancement
Minor
Severity is based on the degree of the bug/task impact on the operation of the system.
Resolution Duplicate
Fixed
Implemented
In Development
Invalid
Wontfix
Worksforme
Please use this field when you set a bug/task on Resolved.
OP-SYS FreeBSD
Linux
Windows 2000
Windows ME
Windows NT
Windows XT
Windows Vista
Other
The operating system(s) on which the bug occurs.
Version 0.8
0.85
SONIVIS version in which the bug occurred or the task is applied to.


References

Please note: The Bug writing guidelines by Eli Goldberg et al. are heavily used to describe the usage of our bug tracking system.


Personal tools