Difference between revisions of "Reporting Bugs"

From Audacity Wiki
Jump to: navigation, search
(Created list of instructions on bug reports)
 
(Steps to Reporting a Bug: update link)
 
(51 intermediate revisions by 8 users not shown)
Line 1: Line 1:
Think you've found a bug in Audacity? Having trouble getting it to work? This page describes how to report this to the development team in a way that will help us find and fix the problem as quickly as possible.
+
{{Intro|Think you've found a bug in Audacity? Having trouble getting it to work? This page describes how to report this to the development team in a way that will help us find and fix the problem as quickly as possible.<p>Bug reports should be made on the [https://forum.audacityteam.org/ Audacity Forum], but '''''please''''' read this page thoroughly before making your report.</p>|}}
  
1) Firstly, you need to make sure that it's genuinely a bug, and not just a feature you haven't found yet in Audacity. The [[http://audacity.sourceforge.net/help/faq FAQ Page]] contains answers to some frequently asked questions, as does this wiki. You can search the main audacity website from the search box at the top of each page, and this wiki from the box at the left hand side.
+
==Steps to Reporting a Bug==
 +
{| style="line-height:12px"
 +
|-
 +
|&nbsp;
 +
|}
 +
{| style="margin-left:25px"
 +
|-valign="top"
 +
|1.&nbsp;
 +
|<span style="font-weight:bold"> First, make sure your problem isn't merely an Audacity feature you haven't found yet! </span> You can find immediate answers to many common questions on the [https://manual.audacityteam.org/o/man/faq.html Frequently Asked Questions] in the [https://manual.audacityteam.org/o/ Manual] and on this Wiki. You can use the search box top right of the [https://web.audacityteam.org/ main Audacity website] to search that website or the Wiki and Forum, or you can search this Wiki from the search box at the left hand side of any page.
 +
|}
 +
{| style="line-height:12px"
 +
|-
 +
|&nbsp;
 +
|}
 +
{| style="margin-left:25px"
 +
|-valign="top"
 +
|2.&nbsp;
 +
|<span style="font-weight:bold">Next, please check your problem isn't already known about.</span> Check the [[Release Notes]] for the current version of Audacity, plus the [[Known Issues]] page for known issues reported since the last release. Some problems are entirely specific to particular operating systems, so please check our pages for known [[Windows Bugs|Windows]], [[Mac OS X|Mac]] and [[Linux Issues|Linux/Unix]] problems. It's also possible issues may come up that haven't yet made it to the Frequently Asked Questions or the Wiki. So please search our [https://forum.audacityteam.org/search.php Forum].  If you don't see your isssue, please consider [https://forum.audacityteam.org/ucp.php?mode=register registering on the Forum] and asking our active user community for help directly. A lot of difficulties that arise turn out not to be bugs at all, and getting help will solve the problem.<br> 
 +
{{Hint|1=Advanced users can also search [https://bugzilla.audacityteam.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=DEVEL%20-%20FIX%20MADE&product=Audacity&query_format=advanced&order=changeddate%20DESC,bug_id Audacity Bugzilla] for the complete current bug list. For information on using Bugzilla, see [[Bug Lists]].}}
 +
|}
 +
{| style="line-height:12px"
 +
|-
 +
|&nbsp;
 +
|}
 +
{| style="margin-left:25px"
 +
|-valign="top"
 +
|3.&nbsp;
 +
|<span style=";font-weight:bold">If you've gone through the above steps without success, you may have found a bug we don't know about, so please tell us about it!</span> Very often problems are only found and fixed when they are reported to us by users trying to do a particular task in Audacity. Please post reports of possible bugs to our [https://forum.audacityteam.org/viewforum.php?f=50 forum]. <span style="font-weight:bold"> Please include all the following six pieces of information in your bug report, so our developers can deal with the problem effectively with the minimum of correspondence:</span>
 +
|}
 +
{| style="line-height:2px"
 +
|-
 +
|&nbsp;
 +
|}
 +
{| style="margin-left:75px"
 +
|-
 +
|*<span style="font-weight:bold"> The exact three-digit version of Audacity you are running</span> for example 2.1.3. You can always find this by clicking {{menu|Help > About Audacity}} in the program (or {{menu|Audacity > About Audacity}} if you are on a Mac computer).
 +
|-
 +
|*<span style="font-weight:bold"> If not downloaded from  </span> [https://web.audacityteam.org our website]<span style="color:#BA55D3;font-weight:bold">, where you obtained Audacity from </span>- for example was it purchased from some other website, bundled on a CD with a hardware product, or obtained from the distributor of your Linux/Unix operating system?
 +
|-
 +
|*<span style="font-weight:bold"> What operating system you are running </span> including the exact version (for example Windows 10, Windows 8.1, macOS 10.15.7, Linux Ubuntu 20.04).
 +
|-
 +
|*<span style="font-weight:bold"> What exactly you are trying to do</span> (for example, import a WAV audio file, use an effect, or record from a microphone attached to a mixer).
 +
|-
 +
|*<span style="font-weight:bold"> What is preventing you doing that, including the exact text of any error messages given. </span>
 +
|-
 +
|*<span style="font-weight:bold"> If Audacity is crashing or freezing, please give us exact steps which always reproduce the crash on your computer</span> (for example, open an AUP (Audacity Project) file, then use the "Amplify" effect).  On Mac, a [http://guides.macrumors.com/Submitting_a_crash_report crash report] will help us, as will a backtrace on Linux/Unix.
 +
|}
  
2) Next, check for late-breaking news and information on the [[http://audacityteam.org/forum/ Audacity Forum]]. If it's a new issue we may not have an FAQ page, but someone on the forum may know about it. Again, [[http://audacityteam.org/forum/search search]] is your friend.
+
The above information will give us a good bug report to go on.
  
3) If you get this far, it's pretty likely we haven't delt with your problem before, so we want you to tell us about it! It's only by users reporting them that we find out about most of the problems with audacity and can fix them.
+
==What Not to Do==
The best way to contact the audacity developers with bug reports is via the [[http://audacity.sourceforge.net/contact/ audacity-help mailing list]]. To make sure that we can deal with the problem effectively, and don't have to keep comming back to you for more information, please include the folling in your report:
+
Here are examples of bad or useless bug reports. We have received bug reports which are every bit as bad as these ones, sometimes with demands for a refund (Audacity software is free).
* The version of audacity you are running
+
* "Audacity crashed! Please fix it."
* Where you obtained audacity from, especially if it is from a Linux distribution or third party and not our website
+
* "It isn't working properly. I have done everything I can."
* What operating system you are running (Windows, Mac OS or whatever).
+
* "I can't hear anything"
* What version of your operating system you are running (XP, 10.4, 9.1 etc).
+
* "I need it fixed immediately. Can you call me?"
* what you did to cause the crash, e.g. Open a file and use the "Amplify" effect.
 
  
This will ensure that (hopefully) the developers can reproduce your problem and so find and fix the bug.
 
  
----
+
{{CategoryTroubleshooting}}[[Category:Participation]]
 
 
Finally, a few things that are pretty much garunteed to get your report ignored:
 
* Adding it to some page on the wiki the developers may never see
 
* Not saying how to reproduce the problem
 
* A general report like "doesn't work" or "crashes all the time"
 

Latest revision as of 14:22, 14 January 2021

Think you've found a bug in Audacity? Having trouble getting it to work? This page describes how to report this to the development team in a way that will help us find and fix the problem as quickly as possible.

Bug reports should be made on the Audacity Forum, but please read this page thoroughly before making your report.

Steps to Reporting a Bug

 
1.  First, make sure your problem isn't merely an Audacity feature you haven't found yet! You can find immediate answers to many common questions on the Frequently Asked Questions in the Manual and on this Wiki. You can use the search box top right of the main Audacity website to search that website or the Wiki and Forum, or you can search this Wiki from the search box at the left hand side of any page.
 
2.  Next, please check your problem isn't already known about. Check the Release Notes for the current version of Audacity, plus the Known Issues page for known issues reported since the last release. Some problems are entirely specific to particular operating systems, so please check our pages for known Windows, Mac and Linux/Unix problems. It's also possible issues may come up that haven't yet made it to the Frequently Asked Questions or the Wiki. So please search our Forum. If you don't see your isssue, please consider registering on the Forum and asking our active user community for help directly. A lot of difficulties that arise turn out not to be bugs at all, and getting help will solve the problem.
Advanced users can also search Audacity Bugzilla for the complete current bug list. For information on using Bugzilla, see Bug Lists.
 
3.  If you've gone through the above steps without success, you may have found a bug we don't know about, so please tell us about it! Very often problems are only found and fixed when they are reported to us by users trying to do a particular task in Audacity. Please post reports of possible bugs to our forum. Please include all the following six pieces of information in your bug report, so our developers can deal with the problem effectively with the minimum of correspondence:
 
* The exact three-digit version of Audacity you are running for example 2.1.3. You can always find this by clicking Help > About Audacity in the program (or Audacity > About Audacity if you are on a Mac computer).
* If not downloaded from our website, where you obtained Audacity from - for example was it purchased from some other website, bundled on a CD with a hardware product, or obtained from the distributor of your Linux/Unix operating system?
* What operating system you are running including the exact version (for example Windows 10, Windows 8.1, macOS 10.15.7, Linux Ubuntu 20.04).
* What exactly you are trying to do (for example, import a WAV audio file, use an effect, or record from a microphone attached to a mixer).
* What is preventing you doing that, including the exact text of any error messages given.
* If Audacity is crashing or freezing, please give us exact steps which always reproduce the crash on your computer (for example, open an AUP (Audacity Project) file, then use the "Amplify" effect). On Mac, a crash report will help us, as will a backtrace on Linux/Unix.

The above information will give us a good bug report to go on.

What Not to Do

Here are examples of bad or useless bug reports. We have received bug reports which are every bit as bad as these ones, sometimes with demands for a refund (Audacity software is free).

  • "Audacity crashed! Please fix it."
  • "It isn't working properly. I have done everything I can."
  • "I can't hear anything"
  • "I need it fixed immediately. Can you call me?"