|Table of Contents|
For those unfamiliar with Eclipse Rich Client Platform (RCP) development and Git source control, it is recommended that you go through the tutorials below. There are two RCP tutorials, the first is for 3.x and is considered "deprecated", but it is the platform that Ergo is built upon until it can be transitioned to 4.x. The second is primarily on 4.x; however, most of the concepts are applicable to both (e.g. extension points, extensions, etc).
- Unzip on your machine to find two files: ergo_format.xml and ergo_cleanup.xml
- Formatter: in Window > Preferences > Java > Code Style > Clean Up and select "Import" and import the ergo-cleanup.xml file. The active profile should say "ERGO".
- To use: Select a source file in Package Explorer (or container/folder/etc.) and select Source menu > Format
- Cleanup in Window > Preferences > Java > Code Style > Formatter and select "Import" and import the ergo-formatter.xml file. The active profile should say "ERGO".
- To use: Select a source file in Package Explorer (or container/folder/etc.) and select Source menu > Cleanup ...
- Optionally Set the editor to apply the formatting changes automatically on save for convenience and consistency in use in Window > Preferences > Java > Editor > Save Actions. Check "Perform the selected actions on save", check "Format source code", and check "Additional actions"
If you haven't already done so, please read the section on code policy here: Contributing Code to Ergo before writing software for the Ergo project.
Adding a New Plug-in
If you are contributing new plug-ins to Ergo, it is recommended that you include unit tests that verify everything is working properly. In addition the the above code guidelines, please do the following: