Difference between revisions of "Bugs"
From OdaWiki
| Line 1: | Line 1: | ||
== Why bother? == | == Why bother? == | ||
| − | * | + | * This helps improve Odamex by making it more robust |
| − | * | + | * This will help improve your bugfinding and testing skills |
| − | * You | + | * You will get mentioned in the credits/contributors list if your report was very helpful (ie fixed a major problem) |
== How to report a bug == | == How to report a bug == | ||
| Line 11: | Line 11: | ||
== What to include == | == What to include == | ||
| − | For a [[crash]], be | + | For a [[crash]], the following information should be included in your report: |
| + | * [[Debugger]] information '''including the callstack''' | ||
| + | * Steps to reproduce the crash (what you did to make it happen) | ||
| + | * Other information including wad files, map, operating system, compiler and configuration (being server config, etc) | ||
| + | |||
| + | If the bug appears to be new and did not appear in a previous [[svn]] revision, it would also be helpful to determine which revision caused the bug. You may need to do [[regression]] testing to work this out and include the revision at which the bug was introduced. | ||
== Good examples == | == Good examples == | ||
* A textbook example is shown in {{Bug|163}} | * A textbook example is shown in {{Bug|163}} | ||
* A good report is provided by {{Bug|116}} | * A good report is provided by {{Bug|116}} | ||
Revision as of 06:47, 20 September 2006
Why bother?
- This helps improve Odamex by making it more robust
- This will help improve your bugfinding and testing skills
- You will get mentioned in the credits/contributors list if your report was very helpful (ie fixed a major problem)
How to report a bug
The Odamex Bug Tracker is an active list of issues. Look through the bugs to see if the bug you want to report is already listed. Please only post reproducible bugs, with steps to reproduce them.
What to include
For a crash, the following information should be included in your report:
- Debugger information including the callstack
- Steps to reproduce the crash (what you did to make it happen)
- Other information including wad files, map, operating system, compiler and configuration (being server config, etc)
If the bug appears to be new and did not appear in a previous svn revision, it would also be helpful to determine which revision caused the bug. You may need to do regression testing to work this out and include the revision at which the bug was introduced.