Changes between Version 11 and Version 12 of WikiStart

01/27/10 23:50:12 (14 years ago)
Valik (IP:

Changes to be more in line with ticket guidelines.


  • WikiStart

    v11 v12  
    11= Welcome to the !AutoIt issue tracker =
    3 The !AutoIt issue tracker is the new system for placing bug reports and feature requests for !AutoIt.  Please take a moment to read over this page and get an understanding of what you need to do in order to help the developers improve the !AutoIt language.
     3The !AutoIt issue tracker is the new system for placing bug reports and feature requests for !AutoIt.  Please take a few moment to read over this page to get an understanding of what you need to do in order to help the developers improve the !AutoIt language.  Below are guidelines, tips and expectations for using this service.
    5 == General Notes ==
    6  * '''Do not open a new ticket for an issue that was just closed.'''   If you have additional information that may help reproduce a ticket that was closed then post in the existing ticket.  Do not open a new ticket.  New tickets on existing issues may be deleted.
    7  * Search for existing issues before creating a new ticket.  If you are reporting an issue with a beta version of AutoIt search the sticky thread called "Latest Beta" in this [ forum].
     5== General Guidelines ==
     6    * Search the issue tracker to see if the ticket has already been discussed.
     7    * Search the [ forum] to see if the issue has been discussed there.
     8    * Do not create a new ticket because an old ticket was closed. Reply to the old ticket if you have additional information and the developers will make the determination if the ticket should be re-opened.
    89 * Please use the following syntax when inserting code.  It helps the code stand out making it easier to read.
    1415 * If you must post a large piece of code then please attach the file instead of posting it in-line.
    15  * When creating a ticket please do not set the Milestone value.  The Milestone value is for developer use only.  The developers set the Milestone when they close a ticket that involves some sort of modification to !AutoIt.  The Milestone the developers set is the '''future''' release of !AutoIt where the bug is fixed or the feature is added.  This may be a version that has not yet been released.
    16  * When creating a ticket please do not set the Blocking flag.  The Blocking flag is for developer use only.  The developers set the Blocking flag when they have open tickets they want to ensure are resolved before the next major release.  What gets considered for blocking is entirely up to the developers and is not subject to discussion except amongst the developers.  Don't set the Blocking flag.
    1716 * Do not demand priority for your issue.  People always suggest their issue should receive priority because it's important to them.  It's a waste of time to suggest priority and will just lead to your ticket being ignored for longer than it would have otherwise been.  It is up to the developers to choose what they want to work on and when it gets worked on.
    1817 * Do not argue about the resolution a ticket is given unless you can prove that closing the ticket was a mistake.
    19  * '''Do not ask for support.'''  This is for bug reports and feature requests only.  See the [ Autoit forum] to ask for support.
     18 * '''Do not ask for support.'''  This is for bug reports and feature requests only.  See the AutoIt [ forum] to ask for support.
    2019 * Tickets should be stand-alone.  They should contain all the information necessary to reproduce the issue without the need for links to the forum.  It is acceptable to link to the forum so the developers may see the discussion that lead to the discovery of the bug.  However, linking to the forum without extricating the pertinent information and using that to create the ticket will result in the ticket being ignored and closed.
    2120 * Each ticket should cover one issue.  Tickets that cover multiple issues are confusing and hard to resolve since some parts may not be completed in a way that matches the ticket's resolution.  If you think you've found multiple related issues, post on the forum first.  Chances are, fixing one issue will resolve the related issues, otherwise they should be separate tickets anyway.
    23 == How to report bugs ==
    24 The developers need a few things from you when you report a bug in order for them to diagnose and fix a bug.
    25  * A short script that reproduces the issue.  The developers don't care what you're trying to do that lead you to discover the bug.  They only care about the bug itself so show only that.
    26  * If the reproduction script requires an external program in order to replicate the bug then try to find alternatives.  Try to demonstrate the bug using an AutoIt GUI instead of an external application.  Try to favor an application that comes standard with Windows.  As a last resort try to find an easy to obtain and install application that demonstrates the issue.  The more complex it is to reproduce a bug the less likely the developers are to spend their time working on it.
    27  * Show the output from the _DebugBugReportEnv() function.  The following script can be used to put the information from that function onto the clipboard.  You can then paste it into your bug report.  This information will help the developers ensure that the problem isn't due to Windows itself.
    28 {{{
    29 #include <Debug.au3>
    30 ClipPut(_DebugBugReportEnv())
    31 }}}
     22== Bug Report Guidelines ==
     23    * If you are asking a question you do not have a bug to report, use the  forum to ask questions.
     24    * You must provide a short test script that reproduces the problem. The script should be no more than the bare minimum code necessary to reproduce the problem.
     25    * Test the reproduction script with both the latest stable and latest beta versions of AutoIt. Check the links to ensure you have the latest versions, AutoIt is updated frequently.
     26    * Please choose the correct version and component for the ticket.
    33 == How to ask for new features ==
    34  * [wiki:AutoItNotOnToDoList A list of things '''not''' on the ToDo list - READ FIRST]
     28== Feature Request Guidelines ==
     29 * Ensure the idea isn't on the list of things we won't do.
    3530 * Seriously, go and read this [wiki:AutoItNotOnToDoList page] again.  Do not ask for these things.
    3631 * When creating a feature request, please unset the version field.  The version field is not used with feature requests.  In addition the blocking and milestone fields should be left empty as well.
    3833 * Don't ask the developers to write UDFs.  If you want to see UDFs added then you'll need to write it or get someone else to write it and submit it with the proper documentation.
    3934 * Don't assume that just because you need a feature that the majority of people will use the feature.  In other words don't ask for very niche things.  This is doubly true if you can do what you need via a UDF.  Things added to the language are intentionally very broad to reduce bloat.
     36== Description of Ticket Fields ==
     37 * '''Type''' - The type of ticket, either a bug report or a feature request.
     38 * '''Component''' - The tool that the problem or request affects.  For example, if you have a problem with one of the UDF's then set the component to "Standard UDFs" instead of leaving it set to AutoIt.
     39 * '''Severity''' - The developers use this field to highlight tickets that are important and need fixed before a specific release.  '''''Only developers may set this field.'''''
     40 * '''Cc''' - Specify an email address here to receive an email notification when the ticket is modified.
     41 * '''Milestone''' - This field is set to the version of AutoIt a change appears in.  For example, if the milestone is set to for a bug report then that bug will be fixed in AutoIt  A bug may be fixed in a version of AutoIt that has not come out yet.  '''''Only developers may set this field.'''''
     42 * '''Version''' - When creating a bug report, specify the version the bug appears.  When creating a feature request please unset this field, it is not used.
     43 * '''Keywords''' - Keywords can be specified here that will help in searching for the ticket.  This field is seldom used.
    4145== Useful Reports ==