How to report a bug - Revision history

AuraFB: /* Message field */

2021-01-18T16:44:18Z

Message field

← Older revision		Revision as of 19:44, 18 January 2021
Line 40:		Line 40:

	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.		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.

			If your bug report is about a specific ship, '''remember to mention the name of the ship.'''

	====Reproduction rate====		====Reproduction rate====

AuraFB: /* Adding screenshots to your report */

2021-01-15T11:18:50Z

Adding screenshots to your report

@@ Line 124: / Line 124: @@
 </pre>
-==Adding screenshots to your report==
+==Screenshots in reporting==
 One picture is worth a thousand words, which is why you can attach an image to your reports sent via the Feedback Tool. However, a good, fancy screenshot isn't necessarily a good screenshot for bug reporting or game feedback. Try to take a screenshot that shows the problem clearly. If possible, adjust your field of vision so that only the essentials are in the picture. Below are some general tips for better feedback screenshots:
@@ Line 133: / Line 133: @@
 * Stay still and don't move while taking a screenshot
 * Ask yourself: is the image clear enough? Can you see at first glance what's in the image and what it's about? If not, try to think if you could take it from a different angle or from a longer/shorter distance to better highlight what the issue is.

AuraFB at 16:20, 14 January 2021

2021-01-14T16:20:05Z

← Older revision		Revision as of 19:20, 14 January 2021
Line 124:		Line 124:
	</pre>		</pre>

	~~That~~'s ~~all! Thank~~ you ~~for reading~~ the ~~tutorial and being part of Starbase Close Alpha!~~		==Adding screenshots to your report==

			One picture is worth a thousand words, which is why you can attach an image to your reports sent via the Feedback Tool. However, a good, fancy screenshot isn't necessarily a good screenshot for bug reporting or game feedback. Try to take a screenshot that shows the problem clearly. If possible, adjust your field of vision so that only the essentials are in the picture. Below are some general tips for better feedback screenshots:

			* The screenshot should be related to what you're reporting
			* Take the screenshot in good lighting, unless the report is specifically about bad lighting or light effects
			* Crop out unrelated objects and other players
			* Stay still and don't move while taking a screenshot
			* Ask yourself: is the image clear enough? Can you see at first glance what's in the image and what it's about? If not, try to think if you could take it from a different angle or from a longer/shorter distance to better highlight what the issue is.

AuraFB: /* Result/Expected */

2020-10-22T08:32:20Z

Result/Expected

← Older revision		Revision as of 11:32, 22 October 2020
Line 57:		Line 57:
	Result = the shortest possible description of what happens when the bug occurs.<br>		Result = the shortest possible description of what happens when the bug occurs.<br>
	Expected = what you expected that would happen instead of what actually happened.		Expected = what you expected that would happen instead of what actually happened.
			<br><br>
	These are the points that we often look at first, so the information should be included here.		These are the points that we often look at first, so the information should be included here.

AuraFB: /* Result/Expected */

2020-10-22T08:32:06Z

Result/Expected

← Older revision		Revision as of 11:32, 22 October 2020
Line 55:		Line 55:
	====Result/Expected====		====Result/Expected====

	Result = the shortest possible description of what happens when the bug occurs.		Result = the shortest possible description of what happens when the bug occurs.<br>
	Expected = what you expected that would happen instead of what actually happened.		Expected = what you expected that would happen instead of what actually happened.

AuraFB: /* Summary */

2020-10-21T16:31:19Z

Summary

← Older revision		Revision as of 19:31, 21 October 2020
Line 1:		Line 1:
	==Summary==		==Summary==

	This is an official tutorial ~~for~~ how to write and send the most effective bug reports, put together with Frozenbyte developers.		Welcome! This is an official tutorial on how to write and send the most effective bug reports, put together with Frozenbyte developers.

	==Why are good bug reports important?==		==Why are good bug reports important?==

AuraFB: /* Result/Expected */

2020-10-21T15:48:35Z

Result/Expected

← Older revision		Revision as of 18:48, 21 October 2020
Line 60:		Line 60:
	These are the points that we often look at first, so the information should be included here.		These are the points that we often look at first, so the information should be included here.

	[[File:tutorial_010_20201021171512_1.png~~\|600px~~]]		[[File:tutorial_010_20201021171512_1.png]]

	===After writing the report===		===After writing the report===

AuraFB: /* Reproduction steps */

2020-10-21T15:48:24Z

Reproduction steps

← Older revision		Revision as of 18:48, 21 October 2020
Line 51:		Line 51:
	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.		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~~]]		[[File:tutorial_009_20201021171512_1.png]]

	====Result/Expected====		====Result/Expected====

AuraFB: /* Reproduction rate */

2020-10-21T15:48:15Z

Reproduction rate

← Older revision		Revision as of 18:48, 21 October 2020
Line 45:		Line 45:
	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 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~~]]		[[File:tutorial_008_20201021171512_1.png]]

	====Reproduction steps====		====Reproduction steps====

AuraFB: /* Discord: for emergencies */

2020-10-21T15:47:26Z

Discord: for emergencies

← Older revision		Revision as of 18:47, 21 October 2020
Line 17:		Line 17:
	==Discord: for emergencies==		==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~~.		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'''.

	[[File:screenshot_discord_report_channel_211020_002.png]]		[[File:screenshot_discord_report_channel_211020_002.png]]
	~~<br><br>~~
			We still recommend following this guide even when reporting via Discord to make sure we have enough information about the problem.

	[[File:screenshot_discord_report_channel_211020_003.png\|600px]]		[[File:screenshot_discord_report_channel_211020_003.png\|600px]]