Difference between revisions of "How to report bugs"
From ECHSA Congenital Database
Jump to navigationJump to searchm |
|||
| Line 3: | Line 3: | ||
== Bug Report Template == | == Bug Report Template == | ||
| − | === | + | ===Step ONE: "When I do"...=== |
You should give a detailed description of consecutive steps, for example: | You should give a detailed description of consecutive steps, for example: | ||
| − | * ''When I click on the "Add Patient" button'' | + | *''When I click on the "Add Patient" button'' |
| − | * ''When I go to the address http://www.eactscongenitaldb.org...'' | + | *''When I go to the address http://www.eactscongenitaldb.org...'' |
| − | * ''When I double click the application icon...'' | + | *''When I double click the application icon...'' |
| − | * ''When I open the '''C:\''' folder...'' | + | *''When I open the '''C:\''' folder...'' |
| − | === | + | ===Step TWO: "This happens"=== |
You should give a description of the symptoms, like this: | You should give a description of the symptoms, like this: | ||
| − | * ''I see an error message: (error message included)'' | + | *''I see an error message: (error message included)'' |
| − | * ''I see wrong text, it says "Mistaek"'' | + | *''I see wrong text, it says "Mistaek"'' |
| − | * ''There is no "DOLV" on the list'' | + | *''There is no "DOLV" on the list'' |
| − | === | + | ===Step THREE: "And I want this to happen"=== |
You should explain what you want to get/see/achieve. For example: | You should explain what you want to get/see/achieve. For example: | ||
| − | * ''I want the application to run'' | + | *''I want the application to run'' |
| − | * ''I want the text to be "Mistake" instead of "Mistaek"'' | + | *''I want the text to be "Mistake" instead of "Mistaek"'' |
| − | * ''I want DOLV to be on the list'' | + | *''I want DOLV to be on the list'' |
| − | == Screenshots == | + | ==Screenshots== |
Screenshots are often a very good way to explain the problem. Under Windows system, you can do a screenshot in the following way: | Screenshots are often a very good way to explain the problem. Under Windows system, you can do a screenshot in the following way: | ||
Revision as of 09:53, 24 September 2005
To submit a helpful bug report, you shouldn't describe what you think that the problem is. You should describe the symptoms instead, just like a patient visiting a doctor. We are aware of the fact that describing does consume more time than you wish, but unfortunately there is no way to avoid that. Otherwise we are very unlikely to help. Please use the following template to report the technical problems:
Contents
Bug Report Template
Step ONE: "When I do"...
You should give a detailed description of consecutive steps, for example:
- When I click on the "Add Patient" button
- When I go to the address http://www.eactscongenitaldb.org...
- When I double click the application icon...
- When I open the C:\ folder...
Step TWO: "This happens"
You should give a description of the symptoms, like this:
- I see an error message: (error message included)
- I see wrong text, it says "Mistaek"
- There is no "DOLV" on the list
Step THREE: "And I want this to happen"
You should explain what you want to get/see/achieve. For example:
- I want the application to run
- I want the text to be "Mistake" instead of "Mistaek"
- I want DOLV to be on the list
Screenshots
Screenshots are often a very good way to explain the problem. Under Windows system, you can do a screenshot in the following way:
- When you see what you want to show us, hold the Prt Scr key for few seconds
- Go to "Paint" program
- Use Edit->Paste
- Save the file in JPG or PNG format
- Send the file to [1]
