How to write a good bug report: step-by-step instructions
The first step in in writing a bug report is to identify exactly what the problem is. Saying “something is wrong” is not helpful; saying exactly what is wrong, and how to reproduce it, is. If you can tell exactly what is wrong, and reliably reproduce an example of the problem, you’ve isolated a bug.
Check if the bug is known
Please check whether the bug you are experiencing is already documented.
File each issue separately
If you have multiple issues, it is better to file them separately so they can be tracked more easily.
The title should describe the problem as best as possible. Use a severity of a bug in a title.
For example: [Critical] Game crashes when removing Small Airport Station.
Severity is the level of impact the bug has on the game.
There is something subjective about severity: when you choosing a level, always think about the product first. How much will the bug affect the core purpose of the product?
- Critical – The bug prevents the user from doing the intended action. They can’t go further. They’re stopped. The bug prevents the user from using a key feature of the game. If the game crashes, it’s critical.
- Major – The bug is highly disturbing for the user but doesn’t prevent them from doing the action. The game logic’s key feature works wrong, but there is a workaround.
- Minor – A bug in the UI which doesn’t prevent usage of the features of the game or some minor issues which don’t break the gameplay.
- Blocker – The bug prevents a user from running/opening the game.
- Suggestion – A suggestion is not a bug, so this means the product works faultlessly and in accordance with the predefined expectations. However, the reporter perceives it as confusing and/or the reporter thinks it does not conform with the standards, or the reporter may be suggesting a new feature for.
Steps to reproduce bug
A bug report requires clear instructions, so that others can consistently reproduce it. Many bugs require some experimentation to find the exact steps that cause the problem you are trying to report.
Describe what should happen if the bug was fixed.
In contrast to the expected behavior, describe what currently happens when the bug is present.
Describe on what device the bug was encountered. For example:
Windows 10 Home 64
9th Generation Intel® Core™ i9-9900K Processor (3.60GHz, up to 5.0GHz with Turbo Boost, 16MB Cache)
1TB M.2 Ultra SSD
32GB DDR4 2666MHz
NVIDIA GeForce RTX 2080 8GB
130W Liquid Cooling
If you can supplement your bug report with a save, image or crash log that helps others reproduce the issue, attach these files.
Crash log location: C:\Users\%userprofile%\AppData\LocalLow\RealWelders\SkyHaven\Player.log
Save file location: C:\Users\%userprofile%\Documents\RealWelders\SkyHaven\Saves
Once a developer marks a bug as fixed, it is a good idea to ensure that it is completely fixed.