Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "PDT/Contributing"

< PDT
m (Add a missing closing parenthesis and text formatting)
(Replaced content with "Category:PDT == Working with PDT source code in Eclipse == Content moved to github: https://github.com/eclipse-pdt/pdt/wiki/Contributing")
 
(13 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
== Working with PDT source code in Eclipse ==
 
== Working with PDT source code in Eclipse ==
  
=== Which Eclipse version? ===
+
Content moved to github: https://github.com/eclipse-pdt/pdt/wiki/Contributing
 
+
To comfortably edit PDT source code and execute it, you can use '''Eclipse for RCP and RAP Developers''', which contains some required plugins (Java Development Tools, Plug-in Development Environment, Git Integration, …).
+
 
+
=== Required plugins ===
+
 
+
In addition to the plugins bundled with Eclipse RCP, PDT requires other plugins that can be installed via the ''Help'' → ''Install New Software…'' menu item.
+
 
+
You'll need to add the following software site (you can add them by clicking the Manage button in the Install dialog):
+
 
+
* DLTK Nightly: http://download.eclipse.org/technology/dltk/updates-dev/latest-nightly
+
* Orbit:
+
** for Eclipse Oxygen.1a: http://download.eclipse.org/tools/orbit/downloads/drops/R20170919201930/repository
+
** for other versions see http://download.eclipse.org/tools/orbit/downloads
+
 
+
Once you defined the above update sites, you should install these plugins:
+
 
+
* Dynamic Languages Toolkit - Core Frameworks SDK
+
* Dynamic Languages Toolkit - Core Lucene Index Frameworks SDK
+
* Dynamic Languages Toolkit - Core H2 Index Frameworks SDK
+
* Dynamic Languages Toolkit - Mylyn Integration
+
* DLTK Core Tests
+
* Eclipse Web Developer Tools
+
* Apache Commons Exec Plug-in
+
* TM Terminal
+
* BIRT Framework
+
* Zest SDK
+
* Parallel Tools Platform
+
* Eclipse/Gerrit integration (aka EGerrit)
+
 
+
=== Importing the PDT Projects ===
+
 
+
To import the PDT projects in Eclipse, choose the ''File'' → ''Import…'' menu item, then choose ''Team'' → ''Team Project Set'', and specify to import from the URL https://git.eclipse.org/c/pdt/org.eclipse.pdt.git/plain/dev/psf/pdt-dev.psf
+
 
+
PS: You can safely disable API Baselines errors (''Window'' → ''Preferences'' menu item, then ''Plug-in Development'' → ''API Baselines'', then choose ''Missing API baseline'' → ''Ignore'').
+
 
+
=== Running and debugging PDT ===
+
 
+
In order to run (and debug) PDT, you can choose the ''Run'' → ''Debug Configurations…'' menu item, and add a new ''Eclipse Application''.
+
 
+
You can keep the default settings, but it's very handy to go to the ''Common'' tab, and check ''Debug'' and ''Run'' in the ''Display in favorites menu'' checklist (so that you'll be able to launch the debug environment by clicking the Debug or Run icons in the toolbar).
+
 
+
When launching the debug application, a new Eclipse instance will be executed: you can create a new PHP project, and you can place breakpoints and analyze the execution in the Eclipse instance containing the PDT project.
+
 
+
PS: when executing PDT, you may see some validation warnings: you can safely ignore them.
+
 
+
 
+
== Preparing and sending patches ==
+
 
+
When you decide to send us your new amazing patch, you'll need:
+
 
+
# an Eclipse account (you can create it [https://accounts.eclipse.org/user/register here])
+
# to sign the [https://www.eclipse.org/contribute/cla Eclipse Contributor Agreement]
+
# a public/private SSH RSA key pair (you can generate them with ssh-keygen on Linux and Mac, and PuTTYgen on Windows)
+
# add the public key to https://git.eclipse.org/r/#/settings/ssh-keys
+
# add your private key to Eclipse (''Window'' → ''Preferences'' menu item, then ''General'' → ''Network Connections'' → ''SSH2'')
+
 
+
Patches must be sent to Gerrit (a review system that can compile PDT and run tests).
+
 
+
In order to create a Gerrit patch from inside Eclipse, switch to the Git perspective (''Window'' → ''Perspective'' → ''Open Perspective'' → ''Git'').
+
 
+
In the ''Git Repositories'' view, you should have ''org.eclipse.pdt'': expand the ''Remotes'' node and right click ''origin'' → ''Gerrit Configuration''.
+
 
+
If your Eclipse username is ''myusername'', specify that
+
* the push URI uses the SSH protocol
+
* the push URI is ssh://myusername@git.eclipse.org:29418/pdt/org.eclipse.pdt.git
+
 
+
Before sending patches, you should file a bug report at https://bugs.eclipse.org: every bug report will be assigned an unique ID (let's say it's 1234)
+
 
+
To send the patch to Gerrit, in the Git perspective of Eclipse, right click the org.eclipse.pdt node in the Git Repositories view, then Commit…
+
 
+
The commit message must be like this:
+
 
+
  Bug 1234 - Description
+
 
+
  Notes
+
 
+
  Change-Id: I0000000000000000000000000000000000000000
+
  Signed-off-by: Your Name <your-email@example.com>
+
 
+
Where:
+
 
+
* 1234<br />is the Eclipse bug ID. In case there's no Eclipse bug associates, use ''No bug'' instead of ''Bug 1234''.<br />If your patch is still in progress, to avoid confusion add a ''[WIP]'' prefix (eg: ''[WIP] No bug - This is an example'').
+
* Description<br />is the main title of the patch.
+
* Notes<br />are optional notes about the patch.
+
* Change-Id: I0000000000000000000000000000000000000000<br />This blank Change-Id line must be added as-is in the commit message.<br />After pushing successfully your patch to Gerrit, Gerrit will create a unique and final ''Change-Id'' to identify your patch.<br />If later you need to update the patch, use the gerrit link added to your bug report to retrieve the ''Change-Id'' value and replace the blank identifier ''I0000000000000000000000000000000000000000'' by the ''Change-Id'' affected to your patch.
+
* Your Name<br />is your real name.
+
* your-email@example.com<br />is your email address.
+
 
+
PS: the commit author and submitter usually have the same value as the Signed-off-by.
+
 
+
By pushing the commit, you'll create - or update - a new Gerrit patch depending on the ''Change-Id'' value of your commit message.
+
The link to view it should be automatically added to your bug report (the link will look like https://git.eclipse.org/r/#/c/112773)
+
 
+
== Compiling PDT outside Eclipse ==
+
 
+
You can compile the PDT source code outside Eclipse.
+
 
+
First of all, you need to clone the PDT git repository:
+
 
+
  git clone http://git.eclipse.org/gitroot/pdt/org.eclipse.pdt.git
+
 
+
If you are an Eclipse user and/or a PDT committer:
+
 
+
  git clone ssh://committerid@git.eclipse.org:29418/pdt/org.eclipse.pdt.git
+
 
+
To build PDT, you need Maven, and launch these commands:
+
 
+
  # project root dir
+
  cd org.eclipse.pdt
+
  # build and run all tests
+
  mvn clean install
+
  # build and ignore all tests
+
  mvn clean install -DskipTests
+
  # build and skip performance tests only (recommend)
+
  mvn clean install -DskipPdtPerformanceTests
+
 
+
To build the PDT release:
+
 
+
  # project root dir
+
  cd org.elipse.pdt
+
  # this will produce normalized, signed and packed release, inside eclipse.org infrastructure
+
  mvn clean install -Prelease
+
  #this will produce normalized and packed release
+
  mvn clean install -Prelease -DskipSign
+
 
+
 
+
== Sonar ==
+
 
+
Sonar is used in order to track Code Quality:
+
# Sonar dashboard: https://dev.eclipse.org/sonar/project/index/org.eclipse.php:org.eclipse.pdt.releng
+
# Reports are ganerated based on dedicated build: https://hudson.eclipse.org/pdt/job/pdt-sonar/#https://hudson.eclipse.org/pdt/job/pdt-sonar
+
 
+
 
+
== Developer Resources ==
+
 
+
After setting up PDT source code please have a look at a set of docs we have for our developers on the [[PDT#Developer_Resources]] page.
+
 
+
 
+
== Update help pages ==
+
 
+
All help pages sitting under plugins/org.eclipse.php.help/docs/source/ in *.md format.
+
 
+
While make install, our build system converting it to *.html files in exactly same structure and also:
+
 
+
# Remove ###- part from each *.md file, and fix all internal links.
+
# Regenerate IPHPHelpContextIds interface
+
# Build helpContexts.xml file
+
# Build toc.xml file
+
 
+
=== Which editor should I use? ===
+
 
+
You can work with any markdown editor, but because our build system use Mylyn Wikitext, you should install wikitext editor from https://eclipse.org/mylyn/downloads/ to be sure that everything is ok.
+
 
+
=== Howto register new help context id? ===
+
 
+
Add this code to markdown file:
+
 
+
  &lt;!--context:your_context_id--&gt;
+

Latest revision as of 07:09, 2 June 2023


Working with PDT source code in Eclipse

Content moved to github: https://github.com/eclipse-pdt/pdt/wiki/Contributing

Back to the top