Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "E4/Scripting/Contribute"

< E4‎ | Scripting
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
== Prerequisites ==
 
== Prerequisites ==
  
To build EASE in Eclipse you should start with 'Eclipse for RCP and RAP Developers'. After startup go to Preferences/Maven/Discovery and click Open Catalog. Afterwards install the Tycho Configurator.
+
To build EASE in Eclipse you should start with ''Eclipse for RCP and RAP Developers'' ([http://www.eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/keplersr2 Kepler SR2], [http://www.eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/lunam7  Luna M7]).
If you want to work on the EMF models you might want to additionally install 'EMF Eclipse Modeling Framework SDK' and 'Diagram Editor for Ecore (SDK)'.
+
  
== Repository locations ==
+
After startup go to ''Preferences/Maven/Discovery'' and click ''Open Catalog''. Continue installing the ''Tycho Configurator''.
  
The core components along with the JavaScript interpreter can be obtained from eclipse directly. Check the [http://git.eclipse.org/c/e4/org.eclipse.e4.scripting.git/ web frontend] for git / http clone urls.
+
Next install the Mylyn Gerrit connector from the Mylyn update site: http://download.eclipse.org/mylyn/releases/latest
The python interpreter is hosted on [https://github.com/adaussy/EScriptMonkey Github] due to licensing issues.
+
We need the ''Mylyn Reviews Connector: Gerrit'' feature.
  
After importing you should set your target platform. Therefore open org.eclipse.ease.releng.target/org.eclipse.ease.releng.target.target and hit 'Set as target platform'.
+
If you want to work on the EMF models you might want to additionally install ''EMF Eclipse Modeling Framework SDK'' and ''Diagram Editor for Ecore (SDK)'' from the official Kepler update site.
 +
 
 +
== Importing Repository ==
 +
 
 +
Short link to Gerrit:
 +
https://git.eclipse.org/r
 +
 
 +
The whole procedure:
 +
 
 +
# Open the ''Git Repositories'' view
 +
# Click ''Clone a Git repository''
 +
# In the dialog select ''Gerrit''
 +
# On the next page hit ''Add...''
 +
# Set ''Server'' to https://git.eclipse.org/r and provide a nice ''Label''. Optionally provide your eclipse credentials, too (necessary to push commits)
 +
# Finish the dialog
 +
# Now you should be back at the repository selection page where you should select ''e4/org.eclipse.e4.scripting'', hit next
 +
# select at least the ''master'' branch
 +
# provide a local path where to keep your repository and check ''Import all existing projects after clone finishes''
 +
 
 +
Getting rid of workspace errors:
 +
 
 +
# locate project ''org.eclipse.ease.releng.target''
 +
# open the contained target definition
 +
# click ''Set as Target Platform'' in the upper right corner of the editor
 +
# all error markers except some on the project ''org.eclipse.ease.ui.expression.xtext.tests'' should be gone
 +
 
 +
If you prefer git over gerrit then check out the [http://git.eclipse.org/c/e4/org.eclipse.e4.scripting.git/ web frontend] for git / http clone urls.
 +
 
 +
The python interpreter is hosted on [https://github.com/adaussy/EScriptMonkey Github] due to licensing issues.
  
 
== Building ==
 
== Building ==
  
 
The whole project can be built by right clicking on org.eclipse.ease.releng / Run As / Maven build. Enter 'clean install' as your goals. After the build process you can find a p2 update site available at org.eclipse.ease.releng.p2/target/repository.
 
The whole project can be built by right clicking on org.eclipse.ease.releng / Run As / Maven build. Enter 'clean install' as your goals. After the build process you can find a p2 update site available at org.eclipse.ease.releng.p2/target/repository.
 +
 +
You could also build from the command line by navigating to the releng project folder and entering 'mvn clean install'.
  
 
== Providing code ==
 
== Providing code ==
  
Currently your best chance to provide code is to create a git patch and submit it via bugzilla. Before creating the patch make sure to have your formatter set to the default 'Eclipse built in'.
+
If you already cloned from gerrit, we would love to get your contributions via gerrit commits. This would be the preferred option.
 +
As an alternative you might provide git patches and submit them via bugzilla. Before creating the patch make sure to have your formatter set to the default 'Eclipse built in'.
  
Have a look at the [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Eclipse&component=Scripting&list_id=8092852&product=e4&query_format=advanced open bugs] if you are not sure where to start.
+
Have a look at the [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Eclipse&component=Scripting&list_id=8092852&product=e4&query_format=advanced open bugs] if you are not sure where to start. [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Eclipse&component=Scripting&keywords=helpwanted&keywords_type=allwords&list_id=8464513&product=e4&query_format=advanced Some of them] are explicitely marked for beginners.
  
 
[[Category:E4|Scripting]]
 
[[Category:E4|Scripting]]
 +
[[Category:How to Contribute]]

Latest revision as of 14:31, 15 May 2014

EASE - Contributing

Prerequisites

To build EASE in Eclipse you should start with Eclipse for RCP and RAP Developers (Kepler SR2, Luna M7).

After startup go to Preferences/Maven/Discovery and click Open Catalog. Continue installing the Tycho Configurator.

Next install the Mylyn Gerrit connector from the Mylyn update site: http://download.eclipse.org/mylyn/releases/latest We need the Mylyn Reviews Connector: Gerrit feature.

If you want to work on the EMF models you might want to additionally install EMF Eclipse Modeling Framework SDK and Diagram Editor for Ecore (SDK) from the official Kepler update site.

Importing Repository

Short link to Gerrit: https://git.eclipse.org/r

The whole procedure:

  1. Open the Git Repositories view
  2. Click Clone a Git repository
  3. In the dialog select Gerrit
  4. On the next page hit Add...
  5. Set Server to https://git.eclipse.org/r and provide a nice Label. Optionally provide your eclipse credentials, too (necessary to push commits)
  6. Finish the dialog
  7. Now you should be back at the repository selection page where you should select e4/org.eclipse.e4.scripting, hit next
  8. select at least the master branch
  9. provide a local path where to keep your repository and check Import all existing projects after clone finishes

Getting rid of workspace errors:

  1. locate project org.eclipse.ease.releng.target
  2. open the contained target definition
  3. click Set as Target Platform in the upper right corner of the editor
  4. all error markers except some on the project org.eclipse.ease.ui.expression.xtext.tests should be gone

If you prefer git over gerrit then check out the web frontend for git / http clone urls.

The python interpreter is hosted on Github due to licensing issues.

Building

The whole project can be built by right clicking on org.eclipse.ease.releng / Run As / Maven build. Enter 'clean install' as your goals. After the build process you can find a p2 update site available at org.eclipse.ease.releng.p2/target/repository.

You could also build from the command line by navigating to the releng project folder and entering 'mvn clean install'.

Providing code

If you already cloned from gerrit, we would love to get your contributions via gerrit commits. This would be the preferred option. As an alternative you might provide git patches and submit them via bugzilla. Before creating the patch make sure to have your formatter set to the default 'Eclipse built in'.

Have a look at the open bugs if you are not sure where to start. Some of them are explicitely marked for beginners.

Back to the top