Bug Reporting - Guidelines on how to write a Bug Report

[MrNibbles]

Greetings interstellar travelers!

In order to help us in QA, and rest of the Dev Team when writing a bug report, I'm providing you all with guidelines on how to write a "proper" bug report (might be useful to both veterans & newcomers on the forums).

This is to make a bug report more structured, and easy to read which in the end will help us to quicker reproduce the bug, and therefore hand in the correct information faster to the Dev Team so that they can fix it. I'll start with writing what a bug report should contain, and follow it up with an example to make things more clear.

What a bug report should contain:

1. Thread Title: Should always include the [version number] & [checksum] of the game and contain a brief description of the issue. In order to find the version number and checksum, start the game and you will be able to find it in the launcher. Can also be found in the in-game menu.

2. Description: Describe the bug/issue in more detail - What occured and what you did in order to make the issue appear.
If you are using an old save after a new patch is released, please do let us know.

3. DLC Information: If you have any dlc's, unit packs etc, please state them here.

4. Mods: If you are using any mods, please state them here.

5. Reproduction Steps: If you are able to reproduce the bug, please write down steps needed to be done in order to achieve the desired result.

6. Attach if possible any screenshot of the issue, and/or a save of said game.
If you are having issues with CTD's (Crash to Desktop) try to always provide a save game, dump file, and logs. These files can be found in your Paradox folder, which is usually found in:

• C:\Users\XXXXX\Documents\Paradox Interactive\Stellaris\save games
• C:\Users\XXXXX\Documents\Paradox Interactive\Stellaris\logs
• C:\Users\XXXXX\Documents\Paradox Interactive\Stellaris\dumps

MAKE SURE THAT YOUR UPLOAD ARE USING ONE OF THE FOLLOWING EXTENSIONS!

.pdf, .png, .jpg, .jpeg, .jpe, .gif, .7z, .crp, .eu4, .rar, .sav, .dmp

See the example below for how a bug report might look like:

####Example Bug Report - Do not take the example as serious for obvious reasons####

v.1.0.0 [9b5a] Selecting the Spaceport makes it "jump" to random system.

Description: Whenever I try to select my spaceport, it gets moved to a random planet & system in the galaxy that is not occupied by any other player or AI.
DLC's: N/A - If we release DLC/Expansion's to Stellaris, add them here in the future!
Mods: I have mod "X" installed and active.

Reproduction Steps:
1. Start the game.
2. Load the attached save game OR Start a New Game, select your Spaceport.
3. Select capital planet.
4. Go to the Spaceport tab.
5. Build a ship.
6. Focus on the ship in order to find the Spaceport in the random system it has ended up in.

Observe: The Spaceport is no longer orbiting your capital planet, but rather can be found over a random planet in the galaxy.

Note that it is understandable that not all the bug reports are able to look like this, as there can arise occasions where it's hard to say what happened in order for the bug to occur. If that is the case simply try to provide with as much information as possible. I hope this will help you out as much as it will help us here in the office if used.

Best Regards,
Mr. Nibbles
Your QA Overlord & Drinker of Tears

 

[killroy_is_thechauffeur]

Bug Report Template courtesy killroy_is_thechauffeur, to copy&paste into each bug report when created.

Title of the thread:

v.1.0.2 [fc5e] Title here.

Content of the thread:

[B]Description:[/B] Describe the bug here.

ADD SCREENSHOT THUMBNAILS HERE (and remove this line)

[B]Savegame:[/B] E.g. single player game; game started in older version (v.1.0.1) but the problems persists in titled version.

DON'T FORGET TO UPLOAD SAVEGAME (and remove this line)

[B]DLC's:[/B] All available until time of this post.
[B]Mods:[/B] None.

[B]Reproduction Steps:[/B]
1. Do this.
2. Then that.

[B]Observe:[/B] What to observe which has to do with the described bug.

 

[Had a dad]

bump