Changes between Version 20 and Version 21 of HowToSubmitTicket


Ignore:
Timestamp:
06/15/15 08:22:01 (22 months ago)
Author:
vadz
Comment:

Emphasize patch submission mechanics even more.

Legend:

Unmodified
Added
Removed
Modified
  • HowToSubmitTicket

    v20 v21  
    2222Except for the most trivial bugs, this is the most important part: to be able to do anything about the problem, we must be able to reproduce it so please provide us with a way to do it. By far the preferred option is to find one of wxWidgets samples (see `samples` subdirectory of your wxWidgets installation) doing something similar to your own program and see if the problem appears in it too. For example, if you have a problem with `wxTreeCtrl`, you should look at the `treectrl` sample, with `wxGrid` -- the `grid` one, and so on. `widgets` sample shows most of the standard widgets, so is a good choice for any problems related to them.
    2323
    24 If the sample doesn't show the problem, please try to '''minimally''' modify its code to make the problem manifest itself or, if you haven't been able to find a sample close to your code, start from the `minimal` sample and try to reproduce the problem in it -- again, with the '''smallest possible''' amount of code. If you can't make the problem appear in the sample, chances are that the bug is actually not in wxWidgets itself, but in your own program. If you can, great, you have found a good way to reproduce the bug and you now just need to make a patch with your changes and attach it to the ticket.
     24If the sample doesn't show the problem, please try to '''minimally''' modify its code to make the problem manifest itself or, if you haven't been able to find a sample close to your code, start from the `minimal` sample and try to reproduce the problem in it -- again, with the '''smallest possible''' amount of code. If you can't make the problem appear in the sample, chances are that the bug is actually not in wxWidgets itself, but in your own program. If you can, great, you have found a good way to reproduce the bug and you now just need to make a patch with your changes and attach it to the ticket (please don't include the patches inline unless it's a literally one line change).
    2525
    2626Making the patch is trivial if you use git: then you just need to run
     
    3636but you can omit `-N` and `-r` parts if you have modified a single file only. However please still run diff from the top level directory and ''not'' from the sample subdirectory to make applying it easier.
    3737
     38To summarize, here are the salient points once again:
     39
     40 1. You should make a single patch with all changes and make from the top of wxWidgets tree.
     41 2. This patch should be in unified diff format.
     42 3. Please attach the patch to the ticket you create.
     43
    3844Once again, please notice that providing a way to reproduce the bug is a vital first step in fixing it. It doesn't guarantee that the bug will be fixed, but if we're not able to reproduce the bug, it does almost guarantees that we will not fix it neither. Thanks in advance for your help!
     45
    3946=== Fatal Bugs ===
    4047