How to Report a Bug

First, thank you for reporting bugs! Identifying, reproducing, and documenting bugs is not always fun or easy, but it’s an important part of making excellent software. It can also be rewarding, as you’ll have a direct influence on the applications. We really, honestly appreciate your help.


How do I report bugs?

Report bugs in Hive, our bug-tracker.

https://hive.panic.com/

If you’ve never used Hive before, you’ll need to create an account.

What’s a bug?

Not all issues are as clear-cut as an application crash or hang. (But we definitely want to know about those, too!) As you use the application, anything that strikes you as weird, unexpected, or broken is probably worth filing in our bug tracker.

Report everything that you find. An issue might be glaringly obvious to you, but if you don’t report it, we may not even know about it.

Search first! Hive has a robust search function. Before writing your bug report, search for a few related keywords to see if it's a known issue.

What does a good bug report look like?

No matter what the bug is, we will always want to know the same information:

One or more of those may seem stupid or self-explanatory to you, but it’s extremely helpful to us if you take the time to write it all out. Don’t assume we know anything! Perhaps you learned how to do something in another app, and we have a totally different way to accomplish the same thing. Simply saying that something “doesn’t work” isn’t very helpful; spell it out for us as simply and clearly as possible.

Any supporting information you can think to add will be appreciated. Attach anything you think might be helpful. Some examples:

What’s all this stuff in the bug description field?

When you go to report a bug using Hive, you’ll see a pre-populated text area labeled Description. This example text shows you how to format your bug report in a clear and readable way. Fill in the appropriate information, hit the Preview button to see how your bug report will look, and report away!

It keeps crashing!

If a computer stops working or an application goes unresponsive, you might say that it crashed. To a software engineer, a crash is a very specific thing, and it may not be what you meant.

Crash

A crash occurs when an application can no longer continue to function, so it quits. Mac OS X says the app unexpectedly quit. The application stops running and writes out a report or log describing what happened. If you encounter an honest-to-goodness crash, we absolutely want to know about it.

You can find the crash log in this folder:

~/Library/Logs/DiagnosticReports/

To get there, click Go in the Finder’s menu bar while holding the Option key () and choose Library. Navigate into the Logs and DiagnosticReports folders, and look for a time-stamped .crash file named for the app that crashed.

Your crash log is helpful, but we’ll probably need more information. Please describe the steps you took to make the crash occur and attach the crash log to your bug.

Hang

Sometimes you’ll see the colorful spinning pinwheel icon, lovingly referred to as the beachball of death. We call this a hang, and it means the application is waiting on some other process to complete before ours can finish what it was doing. Though most hangs are temporary, it’s possible to get stuck in a never-ending spinning-beachball loop, and the only way out is to Force-Quit by pressing ⌥⌘⎋.

Before you force-quit, launch Activity Monitor.app and generate a Sample report. (Look for Activity Monitor inside the Utilities folder in your Applications.) To sample a hanging process, select the hanging app from the list of Process Names in Activity Monitor, click the gear icon in the toolbar, and choose Sample Process.

In your bug, describe how to make the application go into a hang, and attach the Sample report.

Kernel panic

A kernel panic is a kind of system-wide crash. The screen goes gray and a message appears telling you in several different languages that you need to restart your Mac. Usually kernel panics happen deep down in the operating system. Though they may be triggered by our app, the bug probably lies outside of our code. Report these to us all the same. At the very least, we can pass your reports onto Apple.


Thank you!

If you ever have any questions or general feedback for us, just send an email to the support team.

For questions about a specific app, you can use one of these addresses: