Please note: This project is no longer active. The website is kept online for historic purposes only.
If you´re looking for a Linux driver for your Atheros WLAN device, you should continue here .

Changes between Version 8 and Version 9 of TicketSubmissionGuidelines

Author:
mrenzmann (IP: 0.0.0.0)
Timestamp:
03/03/12 22:17:22 (5 years ago)
Comment:

Ticket tracker is closed.

Legend:

Unmodified
Added
Removed
Modified
  • TicketSubmissionGuidelines

    v8 v9  
    1 = Ticket Submission Guidelines
     1= Ticket Tracker Closed
    22 
    33{{{ 
    55<div style="border: solid 2px red; padding: 0.5em; margin: 1em; background: #ffe0e0;"> 
    66}}} 
    7 '''Please read this page carefully before you go on! ''' 
    8  
    9 It contains important information you should know when filing a new ticket. The outlined rules help to avoid common errors that cause a lot of additional work for us.  
    10  
    11 Thanks for your understanding and your cooperation. 
     7The ticket tracker is closed. Please [wiki:news/20120303/ticket-tracker-closed see here] for further information. 
    128{{{ 
    139#!html 
    1410</div> 
    1511}}} 
    16  
    17 [[PageOutline(2-5)]] 
    18 == General Rules == 
    19  
    20  1. '''Please direct any support request to our [wiki:Support regular support channels]'''! Things like "how do I install !MadWifi?" or "how do I configure my WLAN card?" should go there. If you are not sure whether your request should go to a ticket or not, please ask our support first.[[br]][[br]] 
    21  2. Please enter a working e-mail address in the first field of the form.[[br]]Otherwise the ticket engine can't keep you informed about any comments or changes regarding your ticket(s). Please don't obfuscate the address, the ticket engine isn't able to handle this. In other words: use ''user@domain.tld'' rather than ''user <at> domain <dot> tld'' or ''user@REMOVETHIS.domain.tld''.[[br]]Anyway, if you're concerned about getting spam and don't want to enter a working e-mail address, check your ticket(s) regularly. Chances are that we ask for missing information, and we'll close tickets where missing information isn't supplied in time.[[br]][[br]] 
    22  3. One topic per ticket. For example, if you've found three distinct bugs, you'll open three tickets (one per bug).[[br]][[br]] 
    23  4. Give a meaningful summary.[[br]][[br]] 
    24  5. Provide as much information as necessary to understand what your ticket is about. For example, give a step-by-step description of how to reproduce the bug that you have found (remember that others might have a totally different environment).[[br]][[br]] 
    25  6. Preformatted content, such as an extract from your system logs, should go between {{{{{{}}} and {{{}}}}}} ([wiki:WikiFormatting#Preformattedtext details])[[br]][[br]] 
    26  7. In the ticket properties box you should choose at least select correct values for: 
    27    * ''Component'': which component of the project your ticket is refering to 
    28    * ''Version'': only necessary for bug reports or patches; if you choose ''trunk'' here you should add the output of ''svn info'' to the ticket description.[[br]][[br]] 
    29  8. Don't change the default values of ticket properties if you're not sure what they mean, excepts for the properties mentioned in 7. In particular, don't bother changing the milestone entry unless you're a developer, or are '''certain''' you know the correct value.[[br]][[br]] 
    30  9. Use the ''Preview'' button before you submit your ticket. Make sure that your ticket/comment is displayed correctly. 
    31  
    32 [[NewTicketLink(Click here to create a new ticket|or read on for further instructions.)]] 
    33  
    34 == How to... == 
    35  
    36 === ... submit a bug report === 
    37  
    38 We welcome any bug report, without your feedback it's hard (if not impossible) to provide you a high-quality driver. Please help us helping you:  
    39  
    40  1. Make sure that the problem you've found really is a bug. The best way to do so is by discussing the problem on the appropriate mailing list.[[br]][[br]] 
    41  2. If you're not using a recent version of the driver, please try that before you continue. Chances are that the bug already has been fixed. Refer to [wiki:UserDocs/GettingMadwifi GettingMadwifi] to learn how you can get an up-to-date version of MadWifi.[[br]][[br]] 
    42  3. [report:1 See] if someone else already has filed a bug report for the same problem and, if you find a matching ticket, append missing information to this ticket rather than opening a new one. You can also use the search box on the top right of the site to search the whole site. [[br]][[br]] 
    43  4. Open a new ticket (see link below). Choose ''defect'' as ticket type. Give a detailed description on the bug: 
    44    * What did you do when the bug showed up? 
    45    * What did you expect the driver to do instead? 
    46    * Could you reproduce this bug? If so, describe the procedure step by step. 
    47    * Do you have any idea what the bug might have caused? 
    48    * What driver version are you using, what kernel, what WLAN hardware, ...? 
    49    * If your kernel crashed due to the bug, please include a full and decoded dump of the resulting oops message (refer to [wiki:DevDocs/KernelOops] for detailed instructions).[[br]][[br]] 
    50  5. Keep an eye on the ticket. We might need additional information.[[br]][[br]] 
    51  6. Keep your report up-to-date. Let us know if you found additional bits that might be interesting or helpful. 
    52  
    53 [[NewTicketLink(Click here to create a new ticket.)]] 
    54  
    55 === ... submit a patch === 
    56  
    57 Bugfixed and new functionality are best submitted as patches to the current code. The [wiki:DevDocs/PreparePatches PreparePatches] page describes how to prepare your patches for submission. The next steps depend on what you patch does: 
    58  
    59  1. Your patch fixes a bug that has been reported before: 
    60    1. Click on the ''Attach File'' button in the ''Attachments'' section of the appropriate ticket. Click on ''Browse'' and locate the patch file. Enter your e-mail address and a short comment on your patch, then click on ''Add Attachment''. 
    61    2. Verify that your patch is now listed in the ''Attachments'' section. 
    62    3. Write a comment to this ticket to describe your patch. [wiki:DevDocs/SigningPatches Sign off] your patch. Click the "Patch is attached" checkbox. When done, click on the ''Submit Changes'' button at the bottom of the form to send your comment.[[br]][[br]] 
    63  2. Your patch fixes a bug that has not yet been reported: 
    64    1. Open a new ticket (see link below), start the ticket summary with {{{[patch]}}} and select ''defect'' as ticket type. Fill the form as described [wiki:TracTickets#GeneralRules above] - but don't paste your patch in the ticket description! [wiki:DevDocs/SigningPatches Sign off] your patch. Click the "Patch is attached" checkbox. When done click on the ''Submit Changes'' button at the bottom of the form. 
    65    2. The newly created ticket will be displayed. Now click on the ''Attach File'' button in the ''Attachments'' section. Click on ''Browse'' and locate the patch file. Enter your e-mail address and a short comment on your patch, then click on ''Add Attachment''. 
    66    3. Verify that your patch is now listed in the ''Attachments'' section of your ticket.[[br]][[br]] 
    67  3. Your patch adds a new feature: 
    68    1. Open a new ticket (see link below), start the ticket summary with {{{[patch]}}} and select ''enhancement'' as ticket type. Fill the form as described [wiki:TracTickets#GeneralRules above] - but don't paste your patch in the ticket description! [wiki:DevDocs/SigningPatches Sign off] your patch. Click the "Patch is attached" checkbox. When done click on the ''Submit Changes'' button at the bottom of the form. 
    69    2. The newly created ticket will be displayed. Now click on the ''Attach File'' button in the ''Attachments'' section. Click on ''Browse'' and locate the patch file. Enter your e-mail address and a short comment on your patch, then click on ''Add Attachment''. 
    70    3. Verify that your patch is now listed in the ''Attachments'' section of your ticket. 
    71  
    72 That's it. Now you should keep eye on the ticket. Chances are that questions arise or additional information is needed. Thanks for your support. 
    73  
    74 [[NewTicketLink(Click here to create a new ticket.)]] 
    75  
    76 === ... submit a feature request === 
    77  
    78 We're open for any suggestions of new features. Let us know what you would like to see in future versions of MadWifi, by submitting a feature request: 
    79  
    80   1. If you're using an old version of MadWifi, check if the feature is already available in the current version. Refer to [wiki:UserDocs/GettingMadwifi GettingMadwifi] to learn how you can get an up-to-date version of MadWifi.[[br]][[br]] 
    81   2. [report:1 See] if someone else already filed a ticket with a similar request. If so you probably might want to comment on the request and add your own ideas to it.[[br]][[br]] 
    82   3. Open a new ticket (see link below) and select ''enhancement'' as ticket type. Fill the form as described [wiki:TracTickets#GeneralRules above]. Be as verbose as possible when describing your idea. The click on the ''Submit Changes'' button at the bottom of the form. 
    83  
    84 That's it. Now you should keep an eye on the ticket. It's likely that a discussion will be started about your idea, and you might want to add your oppinion on it. 
    85  
    86 [[NewTicketLink(Click here to create a new ticket.)]]