|
|
|
|
|
|
|
Difference between revisions of "How to report a bug"
m (Protected "How to report a bug" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))) |
|||
| Line 1: | Line 1: | ||
==Summary== | |||
This is an official tutorial for how to write and send the most effective bug reports, put together with Frozenbyte developers. | |||
==Why are good bug reports important?== | |||
Everything written in the bug report is helpful and important to us. Still, being concise enough helps us read through the report faster, leaving more time to fix the bug instead. So be as brief possible while not leaving anything out that might be helpful to us. If you are unsure how much and what you should write in the report or if you are thinking of not even writing because of the uncertainty of it’s helpfulness, please do report! It is always better for us to get feedback that includes a chance of giving us even the tiniest bit of information that we would otherwise miss if you did not report. | |||
==F1 Feedback Tool== | |||
The easiest way to make sure that your report gets through to us, you can send bug reports in game by pressing F1 (default keybind) and choosing Bug Report: | |||
[[File:tutorial_001_20201021171512_1.png|600px]] | |||
==Discord: for emergencies== | |||
Try to avoid sending bug reports on Discord - it's much faster for us to read your reports and fix them when sent via the Feedback Tool. If you are unable to use the Feedback Tool for some reason, such as the game crashing, then please send the report on Starbase Discord to the #alpha-tech-problems channel. We still recommend following this guide even when reporting via Discord to make sure we have enough information about the problem. | |||
[[File:tutorial_002_20201021171512_1.png|600px]] | |||
==How to write a report effectively== | |||
Don't worry, we'll show you how to send the best possible bug report! It’s not mandatory to use it for every feedback report, but it is the most optimized way for us to gain all the information we need in one compact package. Please test the bug thoroughly before sending the report to avoid scattering information to multiple bug reports. Updates in case you find more information are always welcome, though! | |||
===Title=== | |||
[[File:tutorial_003_20201021171512_1.png|600px]] | |||
This should be straight-forward and related to the issue - something that explains the bug with as few words as possible. The report is tasked forward to our QA team. We do not ignore any feedback, but QA might not prioritize reports with a title such as "hello". | |||
===Message field=== | |||
[[File:tutorial_006_20201021171512_1.png|600px]] | |||
The message should say what the feedback is about and should only contain necessary information - stay concise and on-topic. Think about what happened before, during and after the bug occurred and describe it. You can certainly add extra information that you think that might be relevant to the problem. | |||
====Reproduction rate==== | |||
Reproduction rate means the amount of times the bug can be reproduced. It's not a big deal if you can't reproduce the bug, but this is one of the main interests for us as it helps us review how much time is needed for testing the bug. Try to reproduce the bug by mimicking your actions that initially caused the problem, and count how many times you were able to repeat it. | |||
[[File:tutorial_008_20201021171512_1.png|600px]] | |||
====Reproduction steps==== | |||
What are the steps needed to reproduce the bug? Write the steps in a numbered list (1, 2, 3...) and be as specific as possible. Leaving out information can greatly impact how we perceive the problem and might even mean that we cannot reproduce the problem at all. | |||
[[File:tutorial_009_20201021171512_1.png|600px]] | |||
====Result/Expected==== | |||
Result = the shortest possible description of what happens when the bug occurs. | |||
Expected = what you expected that would happen instead of what actually happened. | |||
These are the points that we often look at first, so the information should be included here. | |||
[[File:tutorial_010_20201021171512_1.png|600px]] | |||
===After writing the report=== | |||
Please read your bug report through 1-2 times. Is there anything else you could include that would help us process your report? Try to see your report from the recipient's point of view: is it easy to understand? Is it concise? Do you have questions that the report doesn't answer? | |||
===Examples=== | |||
Here are some example reports to help you out! | |||
'''Example 1:'''<br> | |||
[[File:tutorial_007_20201021171512_1.png|600px]] | |||
<pre> | |||
Title: | |||
Soft crash when opening Social menu at Proia | |||
Description: | |||
The game crashes with a soft crash when opening Inventory with I and clicking the Social tab when I'm at the Command Center in Proia station. There is a short delay, 1-5 seconds, after clicking the Social tab during which the game is frozen, and then the crash report pops up. | |||
Repro rate: | |||
Tried 3 times without logging out, crashed each time. | |||
Repro steps: | |||
1. Spawn at the Command Center insurance terminal at Proia | |||
2. Open Inventory with I | |||
3. Click the Social tab | |||
4. Game freezes for 1-5 seconds and game gives an error report when the Social tab loads | |||
Result: game crashes with a soft crash that does not require a restart | |||
Expected: game opens the Social menu normally, without freezing or crashing | |||
</pre> | |||
'''Example 2:'''<br> | |||
[[File:tutorial_005_20201021171512_1.png|600px]] | |||
<pre> | |||
Title: | |||
Chat window does not disappear | |||
Description: | |||
Chat window stays open, despite chat window hide delay being set to 5 seconds. Hide inactive chat window is selected from settings. This happens even if the chat is inactive. Changing chat settings doesn't help. Logging out and restarting the game makes the chat window disappear. | |||
Repro rate: | |||
Tried 5 times, bug reproduced 3 times. | |||
Repro steps: | |||
1. Open game | |||
2. Press Enter to bring up chat | |||
3. Type and send a message in chat with Enter | |||
4. Chat window remains visible | |||
Result: chat window stays visible and doesn't disappear even if chat is inactive, unless player logs out | |||
Expected: chat window disappears after the delay | |||
</pre> | |||
That's all! Thank you for reading the tutorial and being part of Starbase Close Alpha! | |||
Revision as of 17:35, 21 October 2020
Summary
This is an official tutorial for how to write and send the most effective bug reports, put together with Frozenbyte developers.
Why are good bug reports important?
Everything written in the bug report is helpful and important to us. Still, being concise enough helps us read through the report faster, leaving more time to fix the bug instead. So be as brief possible while not leaving anything out that might be helpful to us. If you are unsure how much and what you should write in the report or if you are thinking of not even writing because of the uncertainty of it’s helpfulness, please do report! It is always better for us to get feedback that includes a chance of giving us even the tiniest bit of information that we would otherwise miss if you did not report.
F1 Feedback Tool
The easiest way to make sure that your report gets through to us, you can send bug reports in game by pressing F1 (default keybind) and choosing Bug Report:
Discord: for emergencies
Try to avoid sending bug reports on Discord - it's much faster for us to read your reports and fix them when sent via the Feedback Tool. If you are unable to use the Feedback Tool for some reason, such as the game crashing, then please send the report on Starbase Discord to the #alpha-tech-problems channel. We still recommend following this guide even when reporting via Discord to make sure we have enough information about the problem.
How to write a report effectively
Don't worry, we'll show you how to send the best possible bug report! It’s not mandatory to use it for every feedback report, but it is the most optimized way for us to gain all the information we need in one compact package. Please test the bug thoroughly before sending the report to avoid scattering information to multiple bug reports. Updates in case you find more information are always welcome, though!
Title
This should be straight-forward and related to the issue - something that explains the bug with as few words as possible. The report is tasked forward to our QA team. We do not ignore any feedback, but QA might not prioritize reports with a title such as "hello".
Message field
The message should say what the feedback is about and should only contain necessary information - stay concise and on-topic. Think about what happened before, during and after the bug occurred and describe it. You can certainly add extra information that you think that might be relevant to the problem.
Reproduction rate
Reproduction rate means the amount of times the bug can be reproduced. It's not a big deal if you can't reproduce the bug, but this is one of the main interests for us as it helps us review how much time is needed for testing the bug. Try to reproduce the bug by mimicking your actions that initially caused the problem, and count how many times you were able to repeat it.
Reproduction steps
What are the steps needed to reproduce the bug? Write the steps in a numbered list (1, 2, 3...) and be as specific as possible. Leaving out information can greatly impact how we perceive the problem and might even mean that we cannot reproduce the problem at all.
Result/Expected
Result = the shortest possible description of what happens when the bug occurs. Expected = what you expected that would happen instead of what actually happened.
These are the points that we often look at first, so the information should be included here.
After writing the report
Please read your bug report through 1-2 times. Is there anything else you could include that would help us process your report? Try to see your report from the recipient's point of view: is it easy to understand? Is it concise? Do you have questions that the report doesn't answer?
Examples
Here are some example reports to help you out!
Example 1:
Title: Soft crash when opening Social menu at Proia Description: The game crashes with a soft crash when opening Inventory with I and clicking the Social tab when I'm at the Command Center in Proia station. There is a short delay, 1-5 seconds, after clicking the Social tab during which the game is frozen, and then the crash report pops up. Repro rate: Tried 3 times without logging out, crashed each time. Repro steps: 1. Spawn at the Command Center insurance terminal at Proia 2. Open Inventory with I 3. Click the Social tab 4. Game freezes for 1-5 seconds and game gives an error report when the Social tab loads Result: game crashes with a soft crash that does not require a restart Expected: game opens the Social menu normally, without freezing or crashing
Example 2:
Title: Chat window does not disappear Description: Chat window stays open, despite chat window hide delay being set to 5 seconds. Hide inactive chat window is selected from settings. This happens even if the chat is inactive. Changing chat settings doesn't help. Logging out and restarting the game makes the chat window disappear. Repro rate: Tried 5 times, bug reproduced 3 times. Repro steps: 1. Open game 2. Press Enter to bring up chat 3. Type and send a message in chat with Enter 4. Chat window remains visible Result: chat window stays visible and doesn't disappear even if chat is inactive, unless player logs out Expected: chat window disappears after the delay
That's all! Thank you for reading the tutorial and being part of Starbase Close Alpha!