SDA SE Wiki

Software Engineering for Smart Data Analytics & Smart Data Analytics for Software Engineering

User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
research:pdt:contribute:contribute [2016/04/17 16:38]
127.0.0.1 external edit
research:pdt:contribute:contribute [2018/05/09 01:59] (current)
Line 1: Line 1:
 +====== How to Contribute to the Development of the PDT ======
  
 +===== Install Basic Software =====
 +=== === 
 +  - Install [[http://​www.eclipse.org/​downloads| Eclipse]], Kepler (version 4.3) or newer. Make sure that you **don'​t** use an Eclipse version with an installed PDT. This might lead to conflicts.
 +    * Use an [[http://​www.eclipse.org/​downloads/​compare.php|Eclipse configuration that includes the Plugin Development Environment (PDE)]],
 +       e.g. //​**Classic**//​ or //**Eclipse for RCP and RAP Developers**//​.
 +  - Install [[http://​www.swi-prolog.org/​|SWI-prolog]] Version 6.6 (or newer) for your platform. <- //Skip this step if you want to use another Prolog implementation,​ which you want to integrate with the PDT.// ​
 +    * Windows: Add the "​bin"​ directory of your SWI-Prolog installation to the system PATH.
 +    * Linux: Download the SWI-Prolog sources and see the README.linux file for further instructions. Make sure that all dependencies are loaded correctly (see [[http://​www.swi-prolog.org/​build/​linuxdistro.txt]]). ​
 +
 +===== Get the PDT Code =====
 +=== ===
 +  - [[https://​github.com/​join|Create your free GitHub account]].
 +  - [[https://​help.github.com/​articles/​fork-a-repo|Fork]] the **PDT repository at GitHub ([[https://​github.com/​pdt-git/​public]])** from your account
 +  - Clone your GitHub fork to any place on your hard disk.
 +
 +
 +===== Set-up Eclipse for developing the PDT =====
 +=== === 
 +| On the first start of Eclipse you will see a welcome screen. To start working, \\ close this screen by clicking the arrow on the upper right corner. ​ |  {{:​research:​pdt:​contribute:​screenshot_0.png?​100|}} ​ |
 +| After starting Eclipse ((You might need to close the "​Welcome"​ page after Eclipse has finished starting.)),​ choose **//File -> Import//​** ​ |  {{:​research:​pdt:​contribute:​screenshot_1.png?​100|}} ​ |
 +| Select //**General -> Existing Projects into Workspace**// ​ |  {{:​research:​pdt:​contribute:​screenshot_2b.png?​100|}} ​ |  ​
 +| Select the **//root directory//​** (the location of the PDT sources). \\ \\ Afterwards the list of projects will be filled automatically. \\ Here you should select all projects **except** \\ - PDT Tutorial \\ - pdt.graphicalviews \\ - pdt.updatesite \\ \\ Click //​**Finish**//​ and the projects will be imported to your Eclipse workspace. \\ Importing means that the files are linked from the workspace, not copied into it. \\ They remain at the location where you cloned them.   ​| ​ {{:​research:​pdt:​contribute:​screenshot_3.png?​100|}} ​ |  ​
 +| After importing, Eclipse will automatically compile the projects. \\ The progress will be displayed in the lower right corner. \\ Wait for compilation to finish. |  {{:​research:​pdt:​contribute:​screenshot_4.png?​100|}} ​ |  ​
 +
 +Now you can start modifying the PDT. 
 +
 +<note important>​If you missed the note above and include the "​pdt.graphicalviews"​ plugin there will be a compilation error, since it depends on a licenced library that we may not share via GitHub. However, you can safely ignore it. Just close the "​pdt.graphicalviews"​ project and go on happily. The PDT will work fine, just the graphical views ([[:​research:​pdt:​docs:​contextview|Context View]], ​ [[:​research:​pdt:​docs:​globalview|GlobalView]],​ [[:​research:​pdt:​docs:​loadgraph|Load Graph]] and [[:​research:​pdt:​docs:​logtalk_diagrams| Logtalk Diagrams]]) will not be available. ​
 +</​note>​
 +
 +
 +===== Test your Current State of the PDT =====
 +=== === 
 +| Select any of the PDT projects in the Package Explorer, open its context menu and select \\ //**Run As -> Eclipse Application**// ​  ​| ​ {{:​research:​pdt:​contribute:​screenshot_6.png?​100|}} ​ |
 +| Another Eclipse instance will be started, which will run the PDT code from your development workspace but without the graphical views (see blue note above). ​ ||
 +| The new Eclipse instance will access a new workspace (the so called '​runtime workspace'​) located in the same folder as your development workspace. In the runtime workspace you can create test projects, import your most favourite Prolog code, etc. to test your changes to the PDT. ||
 +
 +===== Make your Changes Available to us =====
 +
 +When you're satisfied with your changes, please ​
 +  - [[https://​help.github.com/​articles/​pushing-to-a-remote|Push]] them to your GitHub repository
 +  - [[https://​help.github.com/​articles/​using-pull-requests|Do a pull request]] ​
 +
 +We'll review your contribution,​ possibly contact you to discuss it and and let you know when we have integrated it. 
 +
 +As soon as your changes are merged by us into the master brach of the GitHub repository, our integration server will generate a fully functional new release (including the graphical views). You will find it on the [[:​research:​pdt:​docs:​download|"​latest"​ PDT update site]]. ​
 +
 +-- //Andreas, Fabian and Günter// ​
research/pdt/contribute/contribute.txt · Last modified: 2018/05/09 01:59 (external edit)

SEWiki, © 2019