Changes between Version 15 and Version 16 of HowToSubmitPatches


Ignore:
Timestamp:
Aug 23, 2020, 11:52:44 PM (5 weeks ago)
Author:
vadz
Comment:

Clearly indicate that GitHub PRs are preferred

Legend:

Unmodified
Added
Removed
Modified
  • HowToSubmitPatches

    v15 v16  
    1313 * '''Unit tests''': Please update (or add) unit tests for any easily testable (i.e. non purely GUI) functionality that you modify or add. Our test suite doesn't cover 100% of wxWidgets code yet but we'd really like it to and we prefer not to add new classes or functions without tests.
    1414
    15  * '''Unicode strings''': If your patch is against 2.8 branch, please remember to use `wxT()` macro around all literal strings and characters (i.e. `wxT("Hello, world!")`, `wxT(':')`) as it is a common error with usually fatal consequences for the Unicode build of the library. Note that this does ''not'' apply to the trunk, where `wxT()` is neither necessary nor desirable anymore.
    16 
    1715 * '''Documentation''': Last but not least, if your patch adds a new feature please include the patch to the documentation as well as undocumented feature is hardly useful to anyone but its author. The API is documented in `/interface` directory, in familiar and simple [http://www.doxygen.org/ Doxygen] format. If you don't do it, another developer would have to write the documentation and the patch won't be applied until he has time to do it.
    1816
    1917== Mechanics of patch submission ==
    2018
    21 You have a choice between using GitHub pull requests (PR) mechanism or creating patches manually, at your convenience. If you already use GitHub, please feel free to open PRs to wxWidgets/wxWidgets repository there. If you don't want to start using it, please use the manual approach described here:
     19If possible, i.e if you already use GitHub, please submit your patches via GitHub pull requests (PR) mechanism, i.e. fork [https://github.com/wxWidgets/wxWidgets/ wxWidgets repository], make a branch with your changes and submit PR to wx (master or 3.0). This has the advantage of building your patch in several different build configurations and rerunning the tests, so it's the preferred way of submitting your changes.
     20
     21However even if you don't use GitHub and don't want to start using it, we still accept plain patches too. For those, please use the manual approach described here:
    2222
    2323 * '''Use the latest version''': Please try to always make your patches against the latest version of wxWidgets.
     
    5151== Submitting the patch ==
    5252
    53  * '''Use Trac''': Please do '''not''' send the patches to the wx-dev mailing list, nor to any developer's personal email address. Instead, use the tracker. Then you will be notified when the patch is accepted or if there is a problem with applying the patch. Alternatively, we will also accept GitHub pull requests, however, we still prefer patches submitted to Trac.
     53 * '''Use Trac''': If you submit your changes as a patch, and not as a GitHub PR, please do '''not''' send the patches to the wx-dev mailing list, nor to any developer's personal email address. Instead, use the tracker. Then you will be notified when the patch is accepted or if there is a problem with applying the patch.
    5454
    5555 * '''Describe your changes''': Please fill in the ticket form according to HowToSubmitTicket and describe the patch as precisely as possible in the `Description` field. Remember that it is often not easy to understand the purpose of your patch just from its source code. Alternatively, you may post a message explaining what your patch does to wx-dev mailing list. If you provide detailed description of the patch, we will be able to apply it much faster -- and we will love you for submitting such nice patches :)