
We love patches, and bug reports with patches attached are especially welcome. Patches will need to be created against the latest development version of Elgg either from Subversion or Github.
All patches are expected to conform to our latest coding standards http://code.elgg.org/elgg/trunk/CODING.txt.
Contents |
Github is the preferred method of contributing to Elgg. It provides a much simpler, more maintainable, and even more fun workflow than the historical SVN method.
If you're not familiar with Git or github, https://github.com has lots of great documentation on how to use both
If you're not comfortable with git(hub), you can help us out the old-school way:
A simple patch is a diff between two files: the modified code you created with a bug fix or enhancement and the original file you started with from svn. A patch can be a collection of changes in multiple files or even the creation of a new file. When you name your patch, make sure to give your file a .diff extension, since this lets the Elgg issue tracker recognize it as a patch, enabling syntax highlighting.
We recommend TortoiseSVN for Windows users, but any decent SVN client will do. You should be able to right click on the base directory (the directory that contains the htaccess_dist file) and select Create Patch from the context menu. It will then show you a list of files that have been changed, added, or deleted compared to the svn version. Select the files that make up your fix and save the file with a .diff extension.
After this the following should only show the changes you have made:
svn status
Now create your patch, by redirecting the output of `svn diff` to an appropriately named file, which preferably includes the revision number of your repository checkout (use `svn info` to determine):
svn diff > 1202_my_issue.diff