How to write a good bug report

Modified on Wed, 6 Sep, 2017 at 12:43 PM

Background

https://www.pixelmedia.com/wp-content/uploads/2016/01/joe-pescatello.jpg

Here are Noodlecake we are responsible for over 100 games on many different platforms. We're a small team with limited resources to track down vague or obscure bugs. If you've found a bug in our games we want to know about it, and the best way to get it fixed is by providing a detailed and complete bug report so that we can take action appropriately. 


When submitting a bug to Noodlecake you'll increase the chance of getting it fixed if you include all the important information. If you make our lives a bit easier we're much more likely to reward you with fixes, updates and improvements. 


What is a bug?

It's important to define what we mean by a software bug. In general, a bug refers to a reproducible software error where the applications does not behave in the way it was designed. For example when a game crashes or when text is unreadable we consider  that a bug. This is different than a request for improvement or feature where you've brainstormed a way to improve the game. Although that's valuable to us, we generally prioritize fixing existing problems before we work on adding new features.


Before you submit your bug report, please ensure you've tried some general troubleshooting steps to make sure it's not a strange one-off circumstance.

What to include in your report

If you've found a bug or glitch we'd appreciate it if you could include all of these details:


  1. Name of the game - The title of the game you've having issues with
  2. Version of the game - The game's version number. You can find this on Android through the App Manager or on iOS by finding the app in the Settings > General > Storage list.
  3. Store - Where did you download the game? App Store, Play Store, Humble Bundle, Amazon App store, Steam?
  4. Hardware model - Include manufacturer and model (e.g. Samsung Galaxy S8)
  5. Platform - Was the game for iOS, Android, PC, Kindle (FireOS)?
  6. Operating system version - The version of iOS, Android, etc installed on your device
  7. Short description of problem - Summarize the problem in a couple sentences
  8. Steps to reproduce issue - Provide detailed step-by-step instructions so that we could reproduce the issue in our office. The more details the better. If you have multiple devices give it a shot on a different device, do you see the same problem?
  9. Expected behavior - What did you expect to happen?
  10. Actual behavior - What actually happened?
  11. Relevant screenshots/video - Include and screenshots, video recording or logs that may be relevant to demonstrate the problem.


Example Report

Here's an example of a great bug report:


Game: Super Stickman Golf 3

Version: 1.7.8 (latest)

Store: Google Play Store

Hardware: Samsung Galaxy S7

Platform: Android

OS version: 7.0 

Short description: Korean language not displaying at all when selected in-game

Steps to reproduce: Open SSG3,  tap settings icon on top left of main menu, tap language select, pick Korean language

Expected behavior: App UI is displayed in Korean

Actual behavior: All places where text should be are instead empty.

Relevant screenshots:



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article