Difference between revisions of "PDE/Contributor Guide"

From Eclipsepedia

< PDE
Jump to: navigation, search
Line 1: Line 1:
== Project Structure ==
+
== Project Structure ==
  
The PDE project is structured into four major components: api tools, build, ui and incubator.
+
The PDE project is structured into four major components: api tools, build, ui and incubator.  
  
=== API Tools ===
+
=== API Tools ===
  
TODO
+
API tooling will assist developers in API maintenance by reporting API defects such as binary incompatibilities, incorrect plug-in version numbers, missing or incorrect @since tags, and usage of non-API code between plug-ins. The tooling will be integrated in the Eclipse SDK and will be used in the automated build process.
 +
Specifically, the tooling is designed to do the following:
  
=== Build ===
+
* Identify binary compatibility issues between two versions of a software component or product.
 +
* Update version numbers for plug-ins (bundles) based on the Eclipse versioning scheme.
 +
* Update @since tags for newly added classes, interfaces, methods, etc.
 +
* Provide new javadoc tags and code assist to annotate types with special restrictions.
 +
* Leverage existing information (in MANIFEST.MF) to define the visibility of packages between bundles.
 +
* Identify usage of non-API code between plug-ins.
 +
* Identity leakage of non-API types into API.
  
TODO
+
=== Build  ===
  
=== UI ===
+
Ant based tools and scripts to automate build processes
  
TODO
+
=== UI  ===
  
=== Incubator ===
+
Models, builders, editors and more to faciliate bundle development
 +
 
 +
=== Incubator ===
  
 
Incubator components vary in maturity level and are supported by the component leads.  
 
Incubator components vary in maturity level and are supported by the component leads.  
Line 25: Line 34:
 
=== Individual Contributors  ===
 
=== Individual Contributors  ===
  
TODO
+
TODO  
  
=== Contributor Links ===
+
=== Contributor Links ===
  
 
*[[Development Conventions and Guidelines|Eclipse Code Conventions]]  
 
*[[Development Conventions and Guidelines|Eclipse Code Conventions]]  
Line 34: Line 43:
 
*[http://en.wikipedia.org/wiki/Eat_one's_own_dog_food Eating your own dog food (Wikipedia)]
 
*[http://en.wikipedia.org/wiki/Eat_one's_own_dog_food Eating your own dog food (Wikipedia)]
  
== Workspace ==
+
== Workspace ==
  
The recommended way to work with PDE is by checking them out of CVS. Doing this makes it easy to try the latest changes and work with patches and ensures that you can easily browse the source code and documentation.
+
The recommended way to work with PDE is by checking them out of CVS. Doing this makes it easy to try the latest changes and work with patches and ensures that you can easily browse the source code and documentation.  
  
=== Setup ===
+
=== Setup ===
  
 
TODO  
 
TODO  
  
=== Tests ===
+
=== Tests ===
  
 
TODO
 
TODO

Revision as of 16:26, 21 July 2009

Contents

Project Structure

The PDE project is structured into four major components: api tools, build, ui and incubator.

API Tools

API tooling will assist developers in API maintenance by reporting API defects such as binary incompatibilities, incorrect plug-in version numbers, missing or incorrect @since tags, and usage of non-API code between plug-ins. The tooling will be integrated in the Eclipse SDK and will be used in the automated build process. Specifically, the tooling is designed to do the following:

  • Identify binary compatibility issues between two versions of a software component or product.
  • Update version numbers for plug-ins (bundles) based on the Eclipse versioning scheme.
  • Update @since tags for newly added classes, interfaces, methods, etc.
  • Provide new javadoc tags and code assist to annotate types with special restrictions.
  • Leverage existing information (in MANIFEST.MF) to define the visibility of packages between bundles.
  • Identify usage of non-API code between plug-ins.
  • Identity leakage of non-API types into API.

Build

Ant based tools and scripts to automate build processes

UI

Models, builders, editors and more to faciliate bundle development

Incubator

Incubator components vary in maturity level and are supported by the component leads.

Getting Started

The PDE project places a very high value on community contributions. This document is intended to help those interested contribute to PDE. It communicates our conventions and discusses ways to get your contributions prioritized.

Individual Contributors

TODO

Contributor Links

Workspace

The recommended way to work with PDE is by checking them out of CVS. Doing this makes it easy to try the latest changes and work with patches and ensures that you can easily browse the source code and documentation.

Setup

TODO

Tests

TODO