Guidelines For Great Bug Reporting

Thanks for helping us improve our software by reporting bugs! We strive to continue making our applications better, and part of that process involves identifying and reproducing bugs. Creating software means designing for an ever-changing platform, and whilst we do our best to squash all bugs before we release each update, in some rare circumstances some obscure bugs can slip through the cracks. By alerting us to issues you’re experiencing, you’re helping us to address problems and rectify them as quickly as possible. You can have a direct impact on bringing the changes you wish to see to RaceHUB.

When something doesn’t work properly, or doesn’t work the way you think it should, we’d genuinely appreciate if you could let us know about it. Even if you think it’s an obvious issue that we’re probably already working on…we might not know about it, and we rely on external reports to inform us of things we might not be seeing over here.

What makes a great bug report?

Certain things are always helpful for us to know, no matter the bug:

  • What you were trying to do when the bug occurred?
  • What steps did you take to trigger this behavior?
  • What did you expect to happen, and what happened instead?

These first few steps help us reproduce your bug. If we can reproduce it on our end, that dramatically improves our ability to test against this behavior and verify our fixes internally.

Next up, we’d like more information about what you’re running, and how you’re running it:

  • The name of the app that you’re using (RaceHUB iOS, RaceHUB macOS, RaceTIME) and version of the app that you’re using. On Mac, version info can also be found by choosing the About item from the Application menu. On iOS, the in-app Settings include an About option.
  • The macOS version and build information or iOS software version that you are running, as well as any recent updates that have been applied (such as Security or video driver updates). The model of your device — iPhone 6 Plus, MacBook Pro (Retina, Mid 2012), etc. — is also appreciated. 
  • If applicable, describe how your device or configuration might differ from an out-of-the-box device. External monitors? Any helper apps or extensions? Third-party keyboard? Jailbreaking or custom OS modifications? 
  • When describing cosmetic issues or anything else visual, it’s a huge help if you can include a screenshot or screen recording that shows what you are seeing. To take a screenshot of your Mac, press Shift-Command-3 (⇧⌘3). A picture will be saved to your Desktop. On iOS, press the Home button and the Sleep/Wake button at the same time. The screen will flash white and a screenshot will be saved to your Photos app. The bigger the screenshot, the better! If you could attach this to your reply, it’ll be very helpful.

Please get in contact with us by sending an email to racehubdeveloper@gmail.com or by using our contact page. This feedback is invaluable to us and ensures that you will always be using power timing and race management software that actually works.

Guidelines For Great Bug Reporting | RaceHUB