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.
Difference between revisions of "OSEE/Developer Guidelines"
< OSEE
(→Code Quality Tools) |
(→Code Quality Tools) |
||
Line 24: | Line 24: | ||
# Restart Eclipse | # Restart Eclipse | ||
− | == | + | == Code Quality Configuration == |
− | # Launch Eclipse and select Window->Preferences | + | === Import OSEE Team Preferences === |
+ | |||
+ | # Launch Eclipse and select '''File->Import->General->Preferences''' | ||
+ | # [http://dev.eclipse.org/svnroot/technology/org.eclipse.osee/trunk/org.eclipse.osee.support.config/osee_team_3.4.epf '''OSEE Team Preferences'''] | ||
+ | |||
+ | |||
+ | |||
+ | # Launch Eclipse and select '''Window->Preferences''' | ||
# Find Bugs use '''default''' settings | # Find Bugs use '''default''' settings | ||
− | # | + | #[http://dev.eclipse.org/svnroot/technology/org.eclipse.osee/trunk/org.eclipse.osee.support.config/codeStyle/] |
== Monitor OSEE Bugs using Mylyn == | == Monitor OSEE Bugs using Mylyn == |
Revision as of 18:25, 24 July 2009
Contents
Setup
Code Quality Tools
Update your eclipse installation with the following tools:
- Find Bugs - Used to perform static analysis on java code - Find Bugs Update Site
- PMD - Additional static analysis and code duplication checks - PMD Update Site
- Check Style - Code Style Checks - Check Style Archived Update Site * This is an archived update site
- Eclipse Emma - Emma Coverage Tool Plugin For Eclipse - see below for install instructions
Installation for Find Bugs, PMD, and Check Style:
- Launch Eclipse and go to Help->Software Updates->Available Software
- Drag the Update Site URLs into the Software Update and Add-ons dialog
- Select code style tools to install - for Find Bugs make sure you only select the Eclipse 3.4 or later entry
- Click the Install button
- Once installation completes, restart eclipse
Installation for Eclipse EMMA:
- Download zip file from the following link Eclipse Emma Zip File
- Unzip downloaded file into your dropins folder
- Restart Eclipse
Code Quality Configuration
Import OSEE Team Preferences
- Launch Eclipse and select File->Import->General->Preferences
- OSEE Team Preferences
- Launch Eclipse and select Window->Preferences
- Find Bugs use default settings
- [1]
Monitor OSEE Bugs using Mylyn
Before Committing Code
- Synchronize and Update
- Run Code Quality Checks
- 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.)
- Ensure the reference documentation is up to date (i.e. reflects your changes) (Documentation is maintained in project 'via the OSEE wiki').