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) |
m (→Code Quality Tools) |
||
| Line 15: | Line 15: | ||
# Drag the Update Site URLs into the '''Software Update and Add-ons''' dialog | # 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''' | # 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 | + | # Click the '''Install''' button |
# Once installation completes, restart eclipse | # Once installation completes, restart eclipse | ||
Revision as of 17:18, 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 - Eclipse Emma Update Site
Installation:
- 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
- Import the following preference file:
Monitor OSEE Bugs using Mylyn
Before Committing Any 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').