You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 42 Next »

Design

  1. Documents
    • Requirements
  2. UML

Implementation

  1. Coding standards
    • Java
    • Other languages
  2. CVS
  3. Exception handling
  4. I18N & L10N
  5. Preferences
  6. UI

Testing

  1. Unit tests

Documentation

  1. Comments
    • JavaDoc
    • Other
  2. Help

Release

  1. Features
  2. Deploying new plugins

Eclipse UI Best Practices

http://wiki.eclipse.org/index.php/UI_Best_Practices_v3.x

Java Coding Standards

We follow the Sun Java code conventions:
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

Additional standards:

  • Package names start with edu.stanford.slac.

Steps for deploying new plugins

  • Increment the version of your plugin.
  • Check out all features from CVS into your Workspace.
  • Delete features from the target directory. (but NOT the plugins!) Note: This is a very wrong step that seems to originate from an Eclipse bug in how features are built against a target.
  • Increment the version of each updated feature.
  • Remove plugins/features from the update site.
  • Export RELEASE feature to SEAL update site (Export... => Plug-in Development => Deployable features)
  • Check out the "update.seal" project from CVS.
  • Update the names and versions of the features in site.xml.
  • Export site.xml to SEAL update site. (Export => General => File System)
  • Start SEAL in "admin"- mode.
  • Update SEAL.
  • Build JavaDoc. (optional)
  • Commit all changes to CVS.
  • Remove all old plugins from the installation site.
  • Remove all unnecessary projects from your workspace.
  • Reload your Plug-in Development target.

NOTE: If something doesn't work, tell everyone who might be concerned, take a break, and start from absolute ZERO!

  • No labels