Difference between revisions of "Reporting Bugs"

From Audacity Wiki
Jump to: navigation, search
m (Reverted edit of Ya4Htn, changed back to last version by Richardash1981)
(Rewrite page with corrected links)
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.
 
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.
  
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.
 
  
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.
+
#<span style="color:#BA55D3;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  {{external|[http://audacity.sourceforge.net/help/faq Frequently Asked Questions page]}} on our main site, and on this Wiki. You can search for information on the {{external|[http://audacity.sourceforge.net/ main Audacity site]}} from the Search box top right of any page, and you can search this Wiki from the search box at the left hand side of any page.
 +
#<span style="color:#BA55D3;font-weight:bold">Next, please check your problem isn't already known about.</span> Check the {{external|[http://audacity.sourceforge.net/download/release-notes Release Notes]}} and the [[Known Issues]] page on this Wiki to read about  known issues with the stable version of Audacity. 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 {{external|[http://www.nabble.com/audacity-help-f4506.html audacity-help mailing list archive]}} and our {{external|[http://audacityteam.org/forum/search.php Forum]}}. If you're using the Beta version of Audacity and have a problem you didn't have in the stable version, narrow your search down to the Audacity Unstable (1.3.x) Forum. If you don't see your problem, please {{external|1=[http://audacityteam.org/forum/ucp.php?mode=register register on the Forum]}} and ask our active user community for help directly. 
 +
#<span style="color:#BA55D3;font-weight:bold">If you've gone through the above two 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 give us reports of possible bugs by sending an email to our  {{external|[mailto:[email protected] audacity-help mailing list]}}.
 +
#<span style="color:#BA55D3;font-weight:bold"> Please include all the following five pieces of information in your bug report, so our developers can deal with the problem effectively with the minimum of correspondence:</span>
  
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.
+
{| style="margin-left:50px"
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:
+
|-
* The version of audacity you are running
+
|*<span style="color:#BA55D3;font-weight:bold"> The exact three-digit version of Audacity you are running</span> for example 1.2.6 or 1.3.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).  
* Where you obtained audacity from, especially if it is from a Linux distribution or third party and not our website
+
|-
* What operating system you are running (Windows, Mac OS or whatever).
+
|*<span style="color:#BA55D3;font-weight:bold"> If not downloaded from  </span>{{external|[http://audacity.sourceforge.net our website]}}<span style="color:#BA55D3;font-weight:bold">, where you obtained Audacity from </span>- for example was it purchased from some other site, bundled on a CD with a hardware product, or obtained from the distributor of your Linux/Unix operating system?
* What version of your operating system you are running (XP, 10.4, 9.1 etc).
+
|-
* what you did to cause the crash, e.g. Open a file and use the "Amplify" effect.
+
|*<span style="color:#BA55D3;font-weight:bold">What operating system you are running </span> including the exact version (for example Windows XP, Windows Vista, Mac OS X 10.4.8, Linux Ubuntu Feisty Fawn).  
 +
|-
 +
|*<span style="color:#BA55D3;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="color:#BA55D3;font-weight:bold">What is preventing you doing that, including the exact text of any error messages given. </span> If Audacity is crashing or freezing, please give us exact steps which always reproduce the crash on your computer (for example, import an .aup  Audacity Project file, then use the "Amplify" effect).
 +
|}
  
This will ensure that (hopefully) the developers can reproduce your problem and so find and fix the bug.
 
  
----
+
The above information will give us a <span style="color:green; font-weight:bold">good </span> bug report to go on.
  
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
+
Here are examples of <span style="color:red;font-weight:bold">bad or useless</span> bug reports that will have us coming back to you for more information (or may mean we can't respond at all):
* Not saying how to reproduce the problem
+
 
* A general report like "doesn't work" or "crashes all the time"
+
*<span style="color:red;font-weight:bold"> "Audacity crashed! Please fix it."</span>
 +
*<span style="color:red;font-weight:bold">"Recording isn't working properly.I have done everything I can."</span>
 +
*<span style="color:red;font-weight:bold">"I can't hear anything"</span>

Revision as of 00:13, 17 September 2007

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.


  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 page  on our main site, and on this Wiki. You can search for information on the main Audacity site  from the Search box top right of any page, and 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  and the Known Issues page on this Wiki to read about known issues with the stable version of Audacity. 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 audacity-help mailing list archive  and our Forum . If you're using the Beta version of Audacity and have a problem you didn't have in the stable version, narrow your search down to the Audacity Unstable (1.3.x) Forum. If you don't see your problem, please register on the Forum  and ask our active user community for help directly.
  3. If you've gone through the above two 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 give us reports of possible bugs by sending an email to our audacity-help mailing list .
  4. Please include all the following five 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 1.2.6 or 1.3.3. You can always find this by clicking Help > About Audacity in the program (or Audacity > About Audacity if you are on a Mac).
* If not downloaded from our website , where you obtained Audacity from - for example was it purchased from some other site, 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 XP, Windows Vista, Mac OS X 10.4.8, Linux Ubuntu Feisty Fawn).
*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, import an .aup Audacity Project file, then use the "Amplify" effect).


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


Here are examples of bad or useless bug reports that will have us coming back to you for more information (or may mean we can't respond at all):

  • "Audacity crashed! Please fix it."
  • "Recording isn't working properly.I have done everything I can."
  • "I can't hear anything"