Bug reporting

From Unvanquished
Jump to: navigation, search

Please file any bugs you find on GitHub using the appropriate issue tracker. Before filing a bug report, however, please check the troubleshooting page, browse the support forums, and search the relevant issue tracker to see if your issue has been noticed or reported before.

Do note that there are separate issue trackers for separate parts of the game and the project:

Please try to do the following when writing a bug report:

  • Describe the problem in detail. Carefully note what actually happens and what you expected to happen.
  • Describe how to reproduce the problem: i.e., steps that the developers can follow to cause it to happen.
  • Do not post console logs or error messages without any other accompanying explanation with the expectation that the developers will solve your problem for you; you must provide details!
  • If the problem is best explained with a picture or video, please, take a screenshot and/or record a demo!

Please include hardware / software specs when you report your bug. Use the following template:

### Hardware / Software

| Release | 
|:--|:--
| Operating System | 
| Video Card | 
| Driver Type | 
| Driver Version | 
| OpenGL Version | 
| Map tested | 
| Renderer used | 

If you are on Linux, please also include fields for your kernel version (which you can obtain from uname) and driver type (i.e., proprietary or open source).

For example, your information might look like this:

### Hardware / Software

| Release | v0.13.0
|:--|:--
| Operating System | Ubuntu 12.04 LTS
| Kernel Version | 3.2.0-38-generic
| Video Card | ATI Radeon HD 5670
| Driver Type | Proprietary (fglrx)
| Driver Version | 8.85-110419a118915C-ATI (Catalyst 11.5)
| OpenGL Version | 4.2.11903 Compatibility Profile
| Map tested | Star A.T.C.S.
| Renderer used | GL3

which will produce a table like so:

Release v0.13.0
Operating System Ubuntu 12.04 LTS
Kernel Version 3.2.0-38-generic
Video Card ATI Radeon HD 5670
Driver Type Proprietary (fglrx)
Driver Version 8.85-110419a118915C-ATI (Catalyst 11.5)
OpenGL Version 4.2.11903 Compatibility Profile
Map tested Star A.T.C.S.
Renderer used GL3

Do's and Don'ts

  • Do include the requested information listed above.
  • Do describe the issue with the bug title. A title of just "Console", for example, does nothing to describe the issue at hand and, as such, makes the issue more difficult to return to for developers, as well as for developers to gauge the impact of the issue. Issues with titles such as "Opening the menu causes the game to crash" will be more likely to be read by a developer than the same issue titled "Menu bug", for example.
  • Do not refer to forum posts or similar anecdotally without providing a link.
  • Do not include extraneous information.
  • Do check to ensure that your grammar and spelling is correct.
  • Do use Markdown headers (begin a line with some number of pound signs, e.g., ###) to delineate sections of your report.

Above all, try to make your report as concise as possible while still including all the necessary information!

Formatting Tips & Tricks

Code Blocks

To delineate a block of code (and enable special formatting such as syntax highlighting), begin and end the code block with four backticks (`):

````
/* code */
````

This makes reports with console output much easier to read and makes it unnecessary to rely on outside paste services.

To enable syntax highlighting, you must specify a language following the first set of backticks:

````diff
/* code */
````

The following language keywords are known to work:

  • diff
  • javascript
  • c
  • c++
  • python