Notice: this Wiki will be going read only early in 2024 and edits will no longer be 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 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 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 - [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''' |
Installation: | Installation: | ||
Revision as of 18:01, 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 Archived Update Site * This is an archived 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
Configuration:
- 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').