Sun Jun 26, 2011 1:57 am
A guide to how to write a good bug report.
Fellow Abine users,
Several months ago Abine asked me to write and article on how to file a bug report that helps them to find and fix any bugs we come across. Sorry, that I didn't get it up sooner, but that is life.
First some things you want to keep handy when using/testing Abine.
1) a notebook and pen or pencil to record your observations in. This comes in handy in trying to isolate those transitory and hard to duplicate bugs. The beta testers I learned this trick from and I find it help to determine what parts of the program are it strengths, and which are the weaknesses. Program teams appreciate hearing about both, for it can aid them in deciding how best to finish the project according to schedule.
2) In that notebook, when you have a bug, record the following: "what other programs do I have running in windows?" From what you remember, what steps led you to this bug?, ie. Switched from site msnbc to abcnews and Abine turned green, or After installing a new Abine security app, I could no longer get Abine to fill in my stored passwords. You will pass these notes on to support and you will want to use them to narrow down the list of possible causes.
3) At least one day a week when you can spend a hour or so uninterrupted to allow you to make sure a bug can be duplicated. If it is, then you start to narrow the possible list of causes and solutions. Do this by seeing if it is caused by a conflict with another program in windows or one of the addon's in FireFox (FF). I find it helpful to start by going to the help menu in FF and use the restart with addon's disabled. I can then keep retrying to duplicate the but after restoring one add-on at a time.
I do just the opposite with windows programs. I turn off 1 program at a time and then after re-booting try to duplicate the issue.
If I find a specific mix of programs and add-ons cause the bug, I forward the combination of I found to support for them to determine how to best deal with the issue.
Especially when dealing with graphic related problems, I like to include a screenshot. I have found "Awesome Screenshot" add-on for FF to be very useful. That program allows me to mark-up the image to show specifically what is wrong. Note: when I include a screen shot I have to compile my bug report in my email program and then send it to support@abine.com When possible forward your graphic setting, monitor resolution, depth of color, type (LCD, LED, or CRT) and video card with which version drivers.
Now I have enough data to provide the best bug report I can.
File a bug report.
1) in the preferences menu page, you'll notice a box "Enable Debug Mode" check this.
2) Duplicate the bug, jotting down which steps you took that resulted in this bug.
3) After duplicating the bug, go back to the "Preferences" page and click on "send a bug". a report window will open. In this window briefly outline what your bug is and why the action you received was not what you expected. Now include the steps you noted earlier that you took to duplicate the bug. If the bug in anyway relates to a display issue, make sure to include what kind of graphic's card you have, the monitor brand, size, resolution and color depth.
Include the functional condition of your machine what OS you are running, how much memory, and your "up-time" or how long since the last boot or restart. The longer you have it on and the more windows that are opened at the same time will influence the number of locations for errors to enter the program. When you first boot-up your computer or restart it, Windows reads and the loads all the necessary settings for it to run smoothly. The longer you have had your machine running, the more errors that creep into that necessary setting list that is stored in your memory.
Also, if you have limited memory and are running multiple programs, Windows moves what data is not needed for the program you are currently using on either the hard disk (virtual memory) or a combination of the virtual memory and stored on a flash card (Ready Boost). The more this data gets moved around, more and more errors creep in.
4) What add-ons, plugins and FF's settings are you using? You can easily get this by going to the "Help" menu and in it select "Troubleshooting Options". This will open a new window which lists all this data. Copy that information to you clipboard.
Submit this and Abine's support staff will have what they need to fix the bug you discovered. Steps to duplicate, possible locations to look for corruption of the running software, other items that could be causing a conflict, and your email so the can contact you with any further questions they may end up with.
If you can't manage to do everything listed above, just try to get as many as possible. Remember, if you are having the problem, so are many others. There reports and yours will keep building until a clear picture of the bug has been supplied to the programmers. You gave them the best information you had, and believe me when I say that they will appreciate the effort you make.
May success be your companion in this effort,
Lord Dude
Several months ago Abine asked me to write and article on how to file a bug report that helps them to find and fix any bugs we come across. Sorry, that I didn't get it up sooner, but that is life.
First some things you want to keep handy when using/testing Abine.
1) a notebook and pen or pencil to record your observations in. This comes in handy in trying to isolate those transitory and hard to duplicate bugs. The beta testers I learned this trick from and I find it help to determine what parts of the program are it strengths, and which are the weaknesses. Program teams appreciate hearing about both, for it can aid them in deciding how best to finish the project according to schedule.
2) In that notebook, when you have a bug, record the following: "what other programs do I have running in windows?" From what you remember, what steps led you to this bug?, ie. Switched from site msnbc to abcnews and Abine turned green, or After installing a new Abine security app, I could no longer get Abine to fill in my stored passwords. You will pass these notes on to support and you will want to use them to narrow down the list of possible causes.
3) At least one day a week when you can spend a hour or so uninterrupted to allow you to make sure a bug can be duplicated. If it is, then you start to narrow the possible list of causes and solutions. Do this by seeing if it is caused by a conflict with another program in windows or one of the addon's in FireFox (FF). I find it helpful to start by going to the help menu in FF and use the restart with addon's disabled. I can then keep retrying to duplicate the but after restoring one add-on at a time.
I do just the opposite with windows programs. I turn off 1 program at a time and then after re-booting try to duplicate the issue.
If I find a specific mix of programs and add-ons cause the bug, I forward the combination of I found to support for them to determine how to best deal with the issue.
Especially when dealing with graphic related problems, I like to include a screenshot. I have found "Awesome Screenshot" add-on for FF to be very useful. That program allows me to mark-up the image to show specifically what is wrong. Note: when I include a screen shot I have to compile my bug report in my email program and then send it to support@abine.com When possible forward your graphic setting, monitor resolution, depth of color, type (LCD, LED, or CRT) and video card with which version drivers.
Now I have enough data to provide the best bug report I can.
File a bug report.
1) in the preferences menu page, you'll notice a box "Enable Debug Mode" check this.
2) Duplicate the bug, jotting down which steps you took that resulted in this bug.
3) After duplicating the bug, go back to the "Preferences" page and click on "send a bug". a report window will open. In this window briefly outline what your bug is and why the action you received was not what you expected. Now include the steps you noted earlier that you took to duplicate the bug. If the bug in anyway relates to a display issue, make sure to include what kind of graphic's card you have, the monitor brand, size, resolution and color depth.
Include the functional condition of your machine what OS you are running, how much memory, and your "up-time" or how long since the last boot or restart. The longer you have it on and the more windows that are opened at the same time will influence the number of locations for errors to enter the program. When you first boot-up your computer or restart it, Windows reads and the loads all the necessary settings for it to run smoothly. The longer you have had your machine running, the more errors that creep into that necessary setting list that is stored in your memory.
Also, if you have limited memory and are running multiple programs, Windows moves what data is not needed for the program you are currently using on either the hard disk (virtual memory) or a combination of the virtual memory and stored on a flash card (Ready Boost). The more this data gets moved around, more and more errors creep in.
4) What add-ons, plugins and FF's settings are you using? You can easily get this by going to the "Help" menu and in it select "Troubleshooting Options". This will open a new window which lists all this data. Copy that information to you clipboard.
Submit this and Abine's support staff will have what they need to fix the bug you discovered. Steps to duplicate, possible locations to look for corruption of the running software, other items that could be causing a conflict, and your email so the can contact you with any further questions they may end up with.
If you can't manage to do everything listed above, just try to get as many as possible. Remember, if you are having the problem, so are many others. There reports and yours will keep building until a clear picture of the bug has been supplied to the programmers. You gave them the best information you had, and believe me when I say that they will appreciate the effort you make.
May success be your companion in this effort,
Lord Dude