Skip to content

How to submit a patch

Daniel Ainasoja edited this page May 15, 2013 · 1 revision

A patch also focuses on fixing/improving one thing, and one thing only. Don't submit several bug fixes in one patch. Split them into several smaller patches instead.

Before you submit you patch, please make sure that you are using the same coding convention as we do. If the patch is messy and violates our convention we reject your patch and kindly ask you to redo it.

Our conventions are:

  • variables and functions names shall be self explanatory
  • use four spaces for tabs
  • insert comments when you feel they are necessary
  • write short and clear commit messages
  • use decent user name and email address

When you have committed your changes to your own origin/master branch, make a pull request. Via the github web interface, push the "Pull request" button and fill the form fields with information that describes the intention of the patch.

If your patch is accepted it will be merged into our master branch and you can later pull our changes to your fork and start working on another patch. No need to re-fork the project when you have done it once already.

Clone this wiki locally