Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "OSEE/Developer Guidelines"

(Before Committing Any Code)
(Code Quality Tools)
Line 8: Line 8:
 
* [http://pmd.sourceforge.net/ PMD] - Additional static analysis and code duplication checks - [http://pmd.sourceforge.net/eclipse PMD Update Site]
 
* [http://pmd.sourceforge.net/ PMD] - Additional static analysis and code duplication checks - [http://pmd.sourceforge.net/eclipse PMD Update Site]
 
* [http://eclipse-cs.sf.net Check Style] - Code Style Checks - [http://sourceforge.net/projects/eclipse-cs/files/Eclipse%20Checkstyle%20Plug-in/v5.0.0final/net.sf.eclipsecs-5.0.0.200906281855-final-updatesite.zip/download Check Style Archived Update Site] '''* This is an archived update site'''
 
* [http://eclipse-cs.sf.net Check Style] - Code Style Checks - [http://sourceforge.net/projects/eclipse-cs/files/Eclipse%20Checkstyle%20Plug-in/v5.0.0final/net.sf.eclipsecs-5.0.0.200906281855-final-updatesite.zip/download Check Style Archived Update Site] '''* This is an archived update site'''
* [http://www.eclemma.org/index.html Eclipse Emma] - Emma Coverage Tool Plugin For Eclipse - [http://sourceforge.net/projects/eclemma/files/1%20EclEmma%20Releases/1.4.1/eclemma-1.4.1.zip/download Eclipse Emma Archived Update Site] '''* This is an archived update site'''
+
* [http://www.eclemma.org/index.html Eclipse Emma] - Emma Coverage Tool Plugin For Eclipse - see below for install instructions
  
Installation:
+
Installation for Find Bugs, PMD, and Check Style:
  
 
# Launch Eclipse and go to '''Help->Software Updates->Available Software'''
 
# Launch Eclipse and go to '''Help->Software Updates->Available Software'''
Line 17: Line 17:
 
# Click the '''Install''' button
 
# Click the '''Install''' button
 
# Once installation completes, restart eclipse
 
# Once installation completes, restart eclipse
 +
 +
Installation for Eclipse EMMA:
 +
 +
# Download zip file from the following link [http://sourceforge.net/projects/eclemma/files/1%20EclEmma%20Releases/1.4.1/eclemma-1.4.1.zip/download Eclipse Emma Zip File]
 +
# Unzip downloaded file into your '''dropins''' folder
 +
# Restart Eclipse
  
 
Configuration:
 
Configuration:

Revision as of 18:08, 24 July 2009

Setup

Code Quality Tools

Update your eclipse installation with the following tools:

Installation for Find Bugs, PMD, and Check Style:

  1. Launch Eclipse and go to Help->Software Updates->Available Software
  2. Drag the Update Site URLs into the Software Update and Add-ons dialog
  3. Select code style tools to install - for Find Bugs make sure you only select the Eclipse 3.4 or later entry
  4. Click the Install button
  5. Once installation completes, restart eclipse

Installation for Eclipse EMMA:

  1. Download zip file from the following link Eclipse Emma Zip File
  2. Unzip downloaded file into your dropins folder
  3. Restart Eclipse

Configuration:

  1. Import the following preference file:

Monitor OSEE Bugs using Mylyn

Integrating OSEE and Bugzilla

Before Committing Code

  1. Synchronize and Update
  2. Run Code Quality Checks
  3. Ensure all the tests are green. (Tests projects can be identified by their '*.test' suffix. All tests have to be executed as plug-in unit tests.)
  4. Ensure the reference documentation is up to date (i.e. reflects your changes) (Documentation is maintained in project 'via the OSEE wiki').

Back to the top