Contributing

Getting Started

Working knowledge of Python is required. Your best bet is to start with a fresh source code snapshot, which you may obtain from our SVN Repository at SourceForge.

Testing and Reporting

Testing on different distributions is also a valuable contribution. Please report your results back to us on safekeep-devel@lists.sourceforge.net. Do not hesitate to provide as much detail as possible in your reports about the problems you are seeing. At a minimum, try to include the following:

Coding Style

Maintain whatever style is present in the code being modified. New code should also follow the style used in the other files so that the entire code-base maintains a unified "look".

Note: please make sure that your Tab size is set to 8. This is the only sane way in which people in a distributed environment can work together. If you are using Eclipse, you need to adjust it as it comes set to 4 by default.

Submitting Patches

Please submit your patches to the development mailing list: safekeep-devel@lists.sourceforge.net. If you aren't sure what exactly a "patch" is, or don't know how to generate one, but you have got code contributions to make, please don't hesitate to ask questions on the mailing lists. Generating and applying patches is an easy thing to get the hang of, and they drastically simplify code submission and review.

Unified contextual diffs against the latest development snapshot are preferred. If you are using Eclipse, there is built-in support for patch generation and application under the "Team" menu.

When submitting patches, please:

Accepted patches will appear in the safekeep-commit@lists.sourceforge.net mailing list. If your patch is not applied, review it carefully and check it against the above points.

Rejected patches will receive a note in the safekeep-devel@lists.sourceforge.net mailing list. We do reply to all patch submissions, so if you receive no response to your patch please try resubmitting it.