Adium

Reporting Bugs

The first step towards reporting a bug is to search the existing tickets.

Most likely, someone else has already done all the work of reporting your bug. If this is the case, feel free to add any additional information you have about the bug to their existing ticket.

If you cannot find an existing ticket (it may take several different searches) on your bug you should create a new one. Please only put one issue in each ticket; it is OK (and preferred) to file multiple tickets if you have multiple issues.

Composing a new Bug Report ticket

Please include the following information in every bug report:

  • Steps to reproduce the problem, include the messaging service (protocol) you are using
  • The version of your Adium and OS X (including your SVN revision, if you are using SVN, and the branch you are using, if you are using SVN but not trunk)
  • The results of each of the troubleshooting steps you have taken to attempt to solve the problem
  • Any Console.app output which occurs when your bug happens (Console.app may be found in /Applications/Utilities), if applicable
    • Attach console output to the ticket with Attach File rather than pasting it into the ticket
  • If you are using Adium in a non-English language, the language in which you use Adium
  • (For visual issues) A screenshot of the problem, in PNG or JPEG format
    • If possible, attach the image to the ticket; a link may later become invalid.
  • (For crashes) The email address or IM handle used when submitting your crash report
    • If you were not able to submit the crash log using the Crash Reporter, attach your crash log to the ticket. If you have not yet relaunched Adium, the crash log is in ~/Library/Logs/CrashReporter. Otherwise, it is in your Trash can.
  • (For freezes or high CPU Usage) A sample of the behavior
  • (For high memory usage) leaks output

Please ensure that you've followed the Troubleshooting Tips to rule out old versions, add-ons, corrupt preferences, or system problems. More information on writing constructive bug reports is also available.

Finally, please make sure to file your ticket in English, as that is the only language that most of our developers understand.

Are you using SVN?

If so, read FilingSVNIssue too. If you don't know if you're using SVN, then you're not.

Debug Logging

It can be helpful to view the debug log when attempting to diagnose a problem. On release versions of Adium debug logging is disabled for performance reasons, however you can download a debug build of the current release with the debug window enabled. See CurrentAdiumDebug for the link and information on retrieving the debug log.

Creating the ticket

You must have an Adium Trac account to create or modify tickets. Creating an account is a one-step process, and no personal information is required. If you choose to list your email address, it will never be added to any list or sold to any party for any reason whatsoever, and you will automatically receive emails when changes are made to tickets which you create or modify. It will not be publicly viewable, so we recommend including it when registering. Click register to create your account. Then, click New Ticket at the top of the page.

If you already have an account, login, then click New Ticket at the top of the page. You can add your email address to your account via settings.

Following up

After you create the ticket, it is a good idea to bookmark it and check it periodically if you do not associate an email address with your Trac account. We may require additional information or have a debug version for you to test. If we can't get this information, we may end up closing the ticket without actually fixing it simply because we don't know enough about the problem.