Contributing

Contributions to the project are always welcome. Whether it is with bug reports, documentation improvements, patches for new features or bug fixes, or suggestions.

Bug reports

Bug reports should go to the ticket system. You'll need to login as guest/guest to enter a new ticket.

Patches

Patches will preferably be in unified diff format and done against a recent checkout from subversion. Then, you can either create a ticket with the patch attached, or attach the patch to a mailing list message, whichever is more convenient for you. If you are looking for tasks needing help, please look at http://elixir.ematia.de/trac/report/1?asc=1&sort=owner and pick any non-assigned ticket you would like to work on. If you are interested to work on an already-assigned ticket, feel free to do so, but please write a comment on the ticket saying so before you start as to not duplicate work.

Coding guidelines

We try to follow PEP8 recommendations as closely as possible. Pay special attention to:

• Indent is 4 spaces.
• Lines are max 79 characters long.

Documentation improvements

If you want to contribute documentation improvements, there are two options:

• if you would like to improve the tutorial, the FAQ or any other page of the wiki, please login as guest/guest and edit the page directly.
• if you would like to improve the API documentation (which is generated from the docstrings of the code), please make your modifications to those docstrings directly (preferably using a recent checkout from subversion) and make a patch out of it (see above).

Suggestions

If you have a suggestion, comment or anything else to say, please use the mailing list.