01.02.2013 Views

Software Development Cross Solution - Index of - Free

Software Development Cross Solution - Index of - Free

Software Development Cross Solution - Index of - Free

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Anatomy <strong>of</strong> a bug report<br />

Different bug tracking systems give you different templates for submitting a bug, but<br />

the basic elements are the same. As a general rule <strong>of</strong> thumb, the more information you<br />

can provide in a bug report, the better. Even if you work on a bug and don’t fix it, you<br />

should record what you’ve done, and any ideas about what else might need to be done.<br />

You—or another developer—might save hours by referring to that information when<br />

you come back to that bug later.<br />

A good bug report should have:<br />

Summary: Describe your bug in a sentence or so. This should be a detailed action<br />

phrase like “Clicking on received message throws ArrayOutOfBoundsException,”<br />

not something like “Exception thrown.” You should be able to read the summary<br />

and have a clear understanding <strong>of</strong> what the problem is.<br />

Steps to reproduce: Describe how you got this bug to happen. You might not<br />

always know the exact steps to reproduce it, but list everything you think might have<br />

contributed. If you can reproduce the bug, then explain the steps in detail:<br />

1. Type “test message” into message box.<br />

2. Click “sendIt.”<br />

3. Click on the received message in the second application.<br />

What you expected to happen and what really did happen: Explain<br />

what you thought was going to happen, and then what actually did happen. This is<br />

particularly helpful in finding story or requirement problems where a user expected<br />

something that the developers didn’t know about.<br />

Version, platform, and location information: What version <strong>of</strong> the s<strong>of</strong>tware<br />

were you using? If your application is web-based, what URL were you hitting? If<br />

the app’s installed on your machine, what kind <strong>of</strong> installation was it? A test build? A<br />

build you compiled yourself from the source code?<br />

Severity and priority: How bad is the impact <strong>of</strong> this bug? Does it crash the<br />

system? Is there data corruption? Or is it just annoying? How important is it that the<br />

bug gets fixed? Severity and priority are <strong>of</strong>ten two different things. It’s possible that<br />

something is severe (kills a user’s session or crashes the application) but happens in<br />

such a contrived situation (like the user has to have a particular antivirus program<br />

installed, be running as a non-Administrator user, and have their network die while<br />

downloading a file) that it’s a low-priority fix.<br />

ending an iteration<br />

What else would you want to see in a bug report? What kind <strong>of</strong> information would<br />

you want to see from the user? How about any kind <strong>of</strong> output from the system?<br />

Download at WoweBook.Com<br />

you are here 4 337

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!