Reporting Bugs: Difference between revisions
imported>Xenbase |
imported>Xenbase |
||
| Line 3: | Line 3: | ||
However, it is very important that we can find your bug so that we can fix it. | However, it is very important that we can find your bug so that we can fix it. | ||
To help us find your bug, please fill out [http://xenbase.org/xenwiki/images/6/6e/Bug_report.txt this] form, and [mailto:xenbase@ucalgary.ca| e-mail it to us]! | To help us find your bug, please fill out [http://xenbase.org/xenwiki/images/6/6e/Bug_report.txt this] form, and [mailto:xenbase@ucalgary.ca| e-mail it to us]! | ||
You can find a sample form that has already been filled out here. | |||
An explanation of how to fill out each of the fields and why they are helpful, is below. | |||
===Date and Time=== | |||
These fields are necessary when someone reports a bug that we cannot find the cause of. We can check Xenbase's error logs at that date and time to see if any errors occurred which might tell us more about the bug. | |||
The seconds of the time field need only be approximations. | |||
=== 1. What is the Problem?=== | |||
Please provide a very short (1-2) sentence summary of the problem. | |||
=== 2. What were you trying to do?=== | |||
This field gives us some context as to what you were attempting to do. It helps us determine which page you were on and pages you were likely to have been on before that. | |||
=== 3. Step-by-step Summary=== | |||
Write out, as well as you can remember, each and every step you took from the moment you decided to do the action in number 2 to the moment the bug from number 1 occurred. | |||
====Why is this important?==== | |||
Some bugs may be crucial to Xenbase running correctly, but may only occur after a user has performed a very specific sequence of steps. The more specific you are about the steps you took (exactly which search box you used, where you reached an image edit page from, etc.)the easier it will be for us to isolate your bug. | |||
An extreme example (unrelated to Xenbase) of how specific a bug report may need to be in order to isolate a bug can be found [http://computingcases.org/case_materials/therac/supporting_docs/therac_resources/produce_malfuction_54.html here]. Each and every step from that bug report would need to be performed correctly in order to generate that bug. | |||
That being said, we understand your time is valuable and very few bugs actually require a report in the above level of detail. Just tell us which buttons you pushed and which pages you navigated to and if we need more information, we will e-mail you. :-) | |||
===4. The Scale From 1 to 6=== | |||
Unfortunately we cannot get to every bug as soon as it is submitted. Some bugs need to wait in our bug queue before we can fix them. To help us prioritize the ordering of these bugs in the queue, we would like to know how inconvenient these bugs are for you. The scale is summarized in the bug report above; however, a more detailed scale can be found below. | |||
1= The problem does not affect my ability to use the website. | |||
2= I can easily work around the problem. | |||
3= I can work around the problem. | |||
4= I can work around the problem with some difficulty. | |||
5= It is very difficult to work around the problem. | |||
6= I cannot work around the problem to use Xenbase to do what I need to do. | |||
==Bug Handling Process== | ==Bug Handling Process== | ||
Revision as of 17:37, 13 July 2012
Reporting a bug in Xenbase
If you find a bug in Xenbase, we would really like to know! However, it is very important that we can find your bug so that we can fix it. To help us find your bug, please fill out this form, and e-mail it to us!
You can find a sample form that has already been filled out here.
An explanation of how to fill out each of the fields and why they are helpful, is below.
Date and Time
These fields are necessary when someone reports a bug that we cannot find the cause of. We can check Xenbase's error logs at that date and time to see if any errors occurred which might tell us more about the bug.
The seconds of the time field need only be approximations.
1. What is the Problem?
Please provide a very short (1-2) sentence summary of the problem.
2. What were you trying to do?
This field gives us some context as to what you were attempting to do. It helps us determine which page you were on and pages you were likely to have been on before that.
3. Step-by-step Summary
Write out, as well as you can remember, each and every step you took from the moment you decided to do the action in number 2 to the moment the bug from number 1 occurred.
Why is this important?
Some bugs may be crucial to Xenbase running correctly, but may only occur after a user has performed a very specific sequence of steps. The more specific you are about the steps you took (exactly which search box you used, where you reached an image edit page from, etc.)the easier it will be for us to isolate your bug.
An extreme example (unrelated to Xenbase) of how specific a bug report may need to be in order to isolate a bug can be found here. Each and every step from that bug report would need to be performed correctly in order to generate that bug.
That being said, we understand your time is valuable and very few bugs actually require a report in the above level of detail. Just tell us which buttons you pushed and which pages you navigated to and if we need more information, we will e-mail you. :-)
4. The Scale From 1 to 6
Unfortunately we cannot get to every bug as soon as it is submitted. Some bugs need to wait in our bug queue before we can fix them. To help us prioritize the ordering of these bugs in the queue, we would like to know how inconvenient these bugs are for you. The scale is summarized in the bug report above; however, a more detailed scale can be found below.
1= The problem does not affect my ability to use the website. 2= I can easily work around the problem. 3= I can work around the problem. 4= I can work around the problem with some difficulty. 5= It is very difficult to work around the problem. 6= I cannot work around the problem to use Xenbase to do what I need to do.