Welcome to Elgg's documentation
This is the place to find documentation on all aspects of Elgg. If you would like to contribute your own documentation please do; we want this to be a real community effort!
Contributing code
From Elgg Documentation
Contents |
[edit] Themes
[edit] Plugins
Coding plugins are the best way to get started with elgg coding. Submit your code to the plugin repository or the subversion plugin repository at https://svn.elgg.org/plugins/. Also visit the issue tracker for plugins, which can assist you in managing the development of your plugin. See Development tools for an overview of all development tools available to you.
[edit] Reporting Bugs
Before reporting a bug in the Trac code management system, be sure to
- search the list of issues for a similar issue
- try to write a clear and complete report, with enough information and context for another person to reproduce the issue.
[edit] Submitting Patches
A bug report with a patch attached are especially welcome! To be able to test your patch, you will have installed elgg. It is preferable to install directly from the svn repository, since its best to file a patch against the latest development version. These are the standard steps to upload a patch to the issue tracker and attach it to the accompanying bug report:
- Resolve your issue, making changes to your working copy of the elgg repository.
- Test your changes. Make sure everything still works as expected
svn status
should only show the files you changed.
- Now make your patch, by redirecting the output of svn diff to an appropriately named file
svn diff > some-name.diff
- Make sure to give your file a .diff extension, since this lets Trac recognize it as a patch, enabling the nice syntax highlighting.
- Open the file one more time in your editor to make sure it says what you meant to.
- Log into Trac, go to http://elgg.org/trac/newticket and file your bug report. Please check the "Patch attached" checkbox on the ticket. Also, be sure to check the "I have a file to attach" checkbox
- Upload the patch.
For further information, contact team@elgg.org or post your question on the forum.
Back to Development frontpage
