Contributing

How to Contribute

We are a truly open source community and therefore appreciate any effort to make ethersex even more awesome. You can help in various ways like writing code, supporting other users (e.g. on IRC) or expanding this wiki with your knowledge.

Writing Code

All your code needs to be GPLv3 or later if you plan to publish your code.

TODO

Coding Style

TODO

Patches

For version control we use Git. Our repository is hosted on github.

If you haven't work with git so far, you should familiarize yourself with it by reading the beginners guide on github.

Fork us!

The help page on github pretty much explains how that works.

To make your life easier you should create a branch for each new feature you will be implementing. NEVER touch the master branch - or you probably will not be able to merge upstream changes into your fork without conflicts.

Pull requests

Pull requests are the easiest way to get your code integrated into the ethersex code base. Developers don't need to send patches around on mailing lists and can respond faster to questions/concerns maintainers may have about the code.

Please read this page in case you don't know who to use pull requests on github.