Changes between Version 11 and Version 12 of HowToSubmitTicket


Ignore:
Timestamp:
Aug 6, 2008, 12:38:53 PM (11 years ago)
Author:
vadz
Comment:

Explain how to describe the bug

Legend:

Unmodified
Added
Removed
Modified
  • HowToSubmitTicket

    v11 v12  
    11= How to Submit a Ticket =
    22
    3 === historical note ===
     3=== Historical Note ===
    44In the old SourceForge tracker we had ''Bugs'', ''Patches'' and ''Feature Requests''.
    55Now we have ''tickets''. If you have ever used wx SF tracker, please read [wiki:WikiStart] to learn how to use the same username.
    66
    7 === introduction ===
     7=== Introduction ===
    88Before creating a new ticket, '''you must login'''. __Make sure that the e-mail address in your preferences is correct.__
    99
    10 Obviously, you should first search if the bug or proposed enhancement is already submitted (use [/search?ticket=on search] for global search or queries to list tickets with the classname in [query:status!=closed&summary~=listctrl title] or [query:status!=closed&keywords~=wxListCtrl keyword]). If you are not sure that you encountered the same bug, open a new ticket and add mutual links to both tickets (`#1234` is automatically linked).
     10Please '''search''' if the bug or proposed enhancement is already submitted (use [/search?ticket=on search] for global search or queries to list tickets with the classname in [query:status!=closed&summary~=listctrl title] or [query:status!=closed&keywords~=wxListCtrl keyword]) before reporting it. If you are not sure that you encountered the same bug, please open a new ticket and add mutual links to both tickets (`#1234` is automatically linked).
    1111
    1212If you want to express interest in a bug that is already submitted, CC yourself or add more details. Or even better, try to fix it.
    1313
    14 === summary ===
     14When reporting a bug, it's usually obvious to the submitter (you) what the problem is. Unfortunately it's quite often less obvious to us (the developers) and the chances of a bug being fixed decrease dramatically if we can't even understand what it is. So please follow this general template when reporting the bugs, with the possible exception of really trivial and self-explanatory ones:
     15
     16 1. Describe what you do, ideally provide a patch to a sample doing it
     17 2. Describe what you expect to happen
     18 3. Describe what happens
     19
     20Variations are possible, of course, but please follow the above steps if in doubt. Also see the descriptions of the individual fields below for more details.
     21
     22=== Summary ===
    1523Like in [https://wiki.ubuntu.com/X/Reporting#head-63f6d4e3e78a5db3d861bc10bdceab01d8c9ad8d other] issue trackers you should select a meaningful title. You may assume that the `summary` will be viewed together with `type` and `component`, so you don't need to write `[wxMac]` if the component is set to `wxMac`.
    1624
    17 === component ===
     25=== Component ===
    1826`Component` is the most important drop-down field.
    1927
     
    3240You can probably guess when to use other options.
    3341
    34 === keywords ===
     42=== Keywords ===
    3543Use full C++ names of relevant classes as keywords (e.g. `wxFileDialog`, not ~~`file dialog`~~ nor ~~`FileDialog`~~).
    3644
     
    4452  * `regression`.
    4553
    46 === version and milestone ===
     54=== Version and Milestone ===
    4755Please set the `version` field but don't set the `milestone`, this field is meant to be used by developers and setting it doesn't help with fixing the bug sooner.
    4856
    49 === cc ===
     57=== CC ===
    5058In the current Trac configuration, reporter is always notified about ticket changes, so there is no need to add yourself to the ''cc'' list. Use this field when you are interested in a ticket opened by someone else.
    5159
    52 === description ===
     60=== Description ===
    5361
    5462Explain how to reproduce the problem. Check if you can see it in the samples. If not, try to make a '''minimal''' modification to one of the samples to demonstrate it and attach this modification as a patch ([http://en.wikipedia.org/wiki/Diff#Unified_format unified] format with extension .diff or .patch is preferred). If the patch only demonstrates the bug, don't check the patch checkbox. You can also attach a minimal complete application in a single `.cpp` file.
     
    6169Write what platform you are using. If you tested also other platforms or older versions, let us know.
    6270
    63 === patch ===
     71=== Patch ===
    6472Attaching a patch that fixes the bug or implements the enhancement you propose will give a higher priority to your ticket. Please read [wiki:HowToSubmitPatches] for the details.
    6573
    66 === final note ===
     74=== Final Note ===
    6775At last, when you see that the bug you reported in the past was fixed, but the ticket is still open, we will appreciate if you close it. You can easily list [query:status!=closed&reporter=$USER&group=component all open bugs you reported].
    6876