wiki:Developers/Getting Started

Getting Started

If you're interested in joining the development effort, please consider joining the development mailing list. (phpeclipse-devel@…, see instructions on http://sourceforge.net/projects/phpeclipse).

Development tools

As of PHPEclipse 1.2 onwards, JDK 1.6 and Eclipse 3.3+ are the "baseline" for development and testing. Earlier code *should* work with earlier Eclipse releases and JDK 1.5 (and even 1.4) in some cases. Generally developers coding against trunk should be working within two major versions of the current Eclipse release.

An installation of "Eclipse Classic" includes everything you need to actually work with the PHPEclipse code, but you'll also need a Subversion plugin installed to access the source code repository; unless you prefer to manage you checkout by hand.

For the sake of being comprehensive:

  • Java Development Tools (JDT) [Included with Eclipse Classic]
  • Plugin Development Environment (PDE) [Included with Eclipse Classic]
  • Either the Subclipse or Subversive subversion client

Downloading the PHPEclipse source from SVN (The "Easy" way)

First, get the appropriate Project Set File (PSF) from trunk/build. The PSF definitions use the Subclipse plugin by default, if you prefer Subversive, look for a file ending in "-subversive.psf". Unless you're addressing an issue in a specific release of PHPEclipse, you'll most likely be looking for phpeclipse-projectset_trunk.psf.

Once you have the PSF file you can have Eclipse automagically import the project set by selecting:

  • File -> Import -> Team / "Team Project Set" and browsing for the downloaded PSF.

Note that the PSF's use anonymous SVN access by default. New developers may be granted commit access by applying to the development team either via the mailing list or IRC.

Downloading the PHPEclipse source from SVN (The "Other" way)

Anonymous SVN access is available via either HTTP. If you prefer to manage your checkouts etc using another tool, you can use http://www.phpeclipse.com/svn/ and select your own paths.

Building the plug-ins

Auto-build should work without errors. Please send a message to the -devel list if following this process results in build errors!

There is a more complicated procedure for building the feature using the Ant build scripts, but that's really only necessary if you're preparing a new release.

[one tip - if you have classpath errors for a plugin, make sure you right click on the project, select PDE tools and update the classpath of these plugins. You can see the .classpath file in the resources perspective in the plugins main directory]

For more background information please read the articles:

Running the plug-ins

Select Run -> Run As -> Eclipse Application or Debug -> Debug As -> Eclipse Application if you want to run the run-time workbench under the Eclipse Java debugger, which is most likely more useful.

Contributing code

Use the Eclipse Team functionality to create patches and then send the patches as text attachments in email to phpeclipse-devel@…. Many small patches are better than fewer, larger patches that fix a single bug or contribute a single feature are better than multi-purpose patches. Expect to move on to direct SVN access after sending in a few good patches - we'd like to grow the active dev team.

Right mouse click on a file, folder or project node in the Navigator view and select menu: Team->Create Patch....

For general background information of the eclipse framework, please see this list of articles: http://eclipse.org/articles/index.html.

Eclipse plugin development resources

List of resources on creating Eclipse Plugins for starters or seasoned developers.

Last modified 6 years ago Last modified on Nov 3, 2010 11:19:46 PM