Contributing to JSwat

Development Documentation

The development related documentation exists with the source code in the docs/dev directory. The documentation explains compiling, building, localizing, and other random notes about developing JSwat.

Coding Conventions

Please read and follow the Java coding conventions when writing code for this project. Use the convenient CheckStyle tool to validate your code. You may even want to use Jalopy to pretty-print your code for you.

Licensing

All source code added to the project must be licensed under the Common Development and Distribution License. This means that your contribution either came from another project under the same license, or you have written the code specifically for this project. Code submitted under any other license cannot be accepted. When adding new files, make sure to include the appropriate license text at the top of the file, in a comment block. Use your own name as the copyright holder.

Code Patches

Patches against existing source code must be in the "unified" diff format. Use the diff -u command to generate the differences. This has the benefit of including two lines of context which is very useful for sending through the patch command (which applies those diffs to the original code).

If you use Microsoft Windows you will need either GNU Cygwin, the Unix emulator for Windows, or the GNU Utilities for Win32 to get a Windows version of the diff command. I recommend Cygwin, as it is easy to install and use.

Submitting Changes

Submit your changes to jswat-dev mailing list for review by the developers. If you are sending several files, feel free to package them into an archive using bzip2, gzip, or zip.