welcome: please sign in

The following 147 words could not be found in the dictionary of 7 words (including 7 LocalSpellingWords) and are highlighted below:
add   adds   Also   and   any   are   as   ask   be   Before   bigger   bug   bugs   but   clean   Clean   cleanly   clear   code   consider   Contents   continue   Core   Create   create   createplugins   Creation   current   Dev   developer   Developers   documentation   documented   does   doing   Doing   don   easy   Easy   edits   either   enough   everybody   explaining   extensions   feature   fix   fixes   following   For   for   found   get   Get   Getting   good   Group   Guide   happy   have   Have   Help   Here   How   how   if   in   include   included   introduce   is   Is   isn   it   It   know   latest   like   likely   maintain   make   members   Mercurial   minor   mixed   more   most   much   necessarily   new   not   of   On   ones   only   or   other   Patch   patch   patches   Patches   possible   production   questions   read   save   self   separated   should   small   Smaller   some   Some   something   source   Started   Team   tells   tested   tests   than   that   the   These   this   time   to   To   understand   useful   user   User   users   version   Way   way   we   Well   well   Wiki   will   without   write   You   you   your   yourself  

Clear message
Page Locked

HelpOnPatchCreation

HelpContents > HelpForDevelopers > HelpOnPatchCreation

You found a way to fix a bug, and you like moin developer to include your fix, but you don't know how to create a patch. Here is how:

1. How to make a new patch

  1. Get the latest version of the source and make your edits. MoinDev/MercurialGuide tells you more.

  2. Before you continue ask yourself the following questions:
    • Is the patch useful to most users? A feature useful for you isn't necessarily useful for everybody.

    • Is it the WikiWay? Doing something the WikiWay is more likely to get included than doing it in any other way.

    • Is this a good patch? Clean, easy to read and understand code is more likely to be included.

    • Have you tested the code well enough? Some of the MoinCoreTeamGroup members like tests for any code, and will not be happy to include new code without tests.

  3. Also consider this:

    • Create extensions if possible!

    • Smaller, cleanly separated patches are much more likely to get included than bigger, mixed ones.

    • Well documented code. To save time, write clear code that is self-explaining. :-)

    • User documentation - if you add a feature, add user documentation.
    • Easy to maintain code - either you or some other developer will have to maintain the code. It should be easy, as we don't have time for this.

2. Patches for current production version

These are only included if: