Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
EDT:Guidelines for moving code from RBD
Revision as of 11:09, 27 June 2011 by Unnamed Poltroon (Talk)
Some of the EDT code is inherited from RBD. Below are some guidelines to follow when moving RBD code to EDT.
- Only move code that is necessary. The functionality in EDT is similar to CE so code for JSFHandlers, VGWebTransactions, TUIs, EGL Web Projects, etc. does not need to be moved. We are not using build descriptors or deployment descriptors in EDT. Some RBD code might need to be rewritten in EDT.
- The naming convention for packages is the plug-in name, followed by 'internal' if it is an internal package. Keep in mind that anything that is external will need to be documented. Each method needs Javadoc, which will be pulled into the Eclipse documentation for EDT.
- Remove the 'EGL' prefix from any class that doesn't need it. For instance, it can stay in 'EGLEditor' for clarity's sake but isn't really needed in 'EGLFixCallbackAction'. In RBD, we have packages where every class is prefixed with 'EGL'. In EDT, we can let the package name specify the context.
- Fix the copyright block at the beginning of each class. Use the new one for EDT. If it is a new class written for EDT, just use 2011. Otherwise, use the year from the old RBD copyright block and 2011 (e.g. 2005, 2011).
- Clean up the code.
- Remove @author and @since tags.
- Remove any commented out code that has been around for a while and is not likely to change.
- Revisit any code whose comments reference a bug.
- Run a code scan on any new classes added to EDT from RBD. The instructions are at https://radical.rtp.raleigh.ibm.com/egl/37585-ibm/38907-ibm/40677-ibm.html. You only need to run a code scan, not the other two types of scans.