How to report a bug

Dealing with bugs it’s never fun… keep reading to discover what you can do about it. Thanks in advance for your time and help.

What’s a bug?

Whenever an app crashes or hangs you’ve probably found a bug! Although, a bug can also be a smaller issue like a visual glitch, laggy animation, or wrong translation. Basically anything that seems weird, broken, or out of place might be a bug.

Please report anything you find, big or small it is. Also don’t assume we’re aware of a certain bug even if it seems obvious. An issue might be caused by a specific configuration, workflow, or set of apps you have that we don’t.

How to report a bug

You can send us an email to [email protected] with your bug report. Make sure to tell us as much details as possible.

What’s a bug report?

A bug report is nothing more than a simple email where you explain us the issue you stumbled upon. You can go as further as you want in terms of details. However, generally speaking more context we have the higher the chances to fix the issue.

Here are some basic questions you should try to answer:

  • What did you try to do?
  • What steps did you take?
  • What did you expect to happen?
  • What happened instead?

If you really want to do the extra mile, consider to do the following as well:

  • Transcripts & Logs. Attach any relevant transcript or log file. Usually our apps have a mechanism to export messages and errors. Some apps are also able to submit reports directly when a crash happens
  • System configuration. Tell us how your machine might differ from a stock one (plugins, extensions, additional monitors, etc)
  • Console messages. Use the Console app to record relevant messages from our apps, the operating system, or other apps that might clash with ours. If you want to only see messages from us, you can use the “Subsystem” filter. We always use identifiers similar to house.panini.brewer
  • Screenshots & recordings. Attach a screenshot or screen recording of the issue. This is usually one of the easier and faster way to show us what’s wrong. On macOS you can take a screenshot by pressing ⇧⌘4