Jump to: navigation, search

Difference between revisions of "Vex/CommitterResources"

< Vex
(Setup a Workspace)
Line 8: Line 8:
  
 
== Setup a Workspace ==
 
== Setup a Workspace ==
* Install the EGit team provider
+
Vex is available through the Eclipse Oomph Installer. To setup a workspace, do the following steps:
 +
# Get the [[Setup-Eclipse|Eclipse Oomph Installer]], unzip it and start it.
 +
# Select "Eclipse Standard/SDK" on the "Product" page and press "Next"
 +
# Double-click on "Vex" on the "Projects" page and press "Next"
 +
# Fill out the "Variables" page as it fits best to your desired environment and press "Next"
 +
# Check the planned bootstrap tasks on the "Confirmation" page and press "Next" to start the actual installation of the IDE
 +
# Press "Finish" after the installation is done.
  
For committers:
+
It will take a moment until your new Vex IDE is started, just be patient. Some seconds after the start, again a installation wizard is opened where you have to confirm the configuration tasks for the new IDE.
* Configure and clone the Mylyn Docs Vex Git repository including the branch ''master'':
+
    ssh://<your_username>@git.eclipse.org/gitroot/mylyn/org.eclipse.mylyn.docs.vex.git
+
* Import all projects (prefix ''org.eclipse.vex'') into your workspace
+
* Checkout the branch ''master'' for the "latest and greatest" code
+
 
+
For other contributors:
+
* Import the Team Project Set from
+
    http://git.eclipse.org/c/mylyn/org.eclipse.mylyn.docs.vex.git/plain/org.eclipse.vex.releng/vex.psf
+
 
+
For all (after cloning the Git repository)
+
* Configure the target definition ''vex.target'', which is stored in the releng plug-in.  If no specific editor appears, it means that you need to install the ''Eclipse Releng Tools'' from the eclipse update site.
+
* Use the launch configuration ''Vex'' to start a run-time workbench which includes Vex
+
 
+
Please bear in mind to configure your name and email address in git before cloning the repository:
+
    git config --global user.name "Your Name"
+
    git config --global user.email <your_bugzilla_email_address>
+
  
 
== Patches and Bug Fixes ==
 
== Patches and Bug Fixes ==
  
Please use a local branch for your changes and create a patch as described in the [[EGit/User_Guide #Creating_Patches|EGit User Guide]]. At the moment you have to create one patch for each plug-in that you have changed.
+
Please provide us your contributions through the Gerrit Code Review system of the Eclipse Foundation. For more information about how to use Gerrit, please see [[Development_Resources/Contributing_via_Git]].
  
 
Bug fixes that come with unit tests are more likely to be reviewed sooner than those that do not come with unit tests. Patches over 250 lines of code will have to be sent through eclipse IP review.
 
Bug fixes that come with unit tests are more likely to be reviewed sooner than those that do not come with unit tests. Patches over 250 lines of code will have to be sent through eclipse IP review.
Line 38: Line 28:
 
== Build ==
 
== Build ==
  
With [http://eclipse.org/tycho/ Tycho] see [http://live.eclipse.org/node/1003 "Tycho - Building Eclipse Plugins with Maven"]
+
Vex is build with [http://eclipse.org/tycho/ Tycho] (see [http://live.eclipse.org/node/1003 "Tycho - Building Eclipse Plugins with Maven"]) on its own [https://hudson.eclipse.org/vex/ Hudson instance].
  
 
= Getting Help =
 
= Getting Help =
  
Committers watch and hang out on a variety of eclipse resources channels. Include #eclipse irc channel on freenode.net. Also, we monitor both the incubator newsgroup as well as the main webtools newsgroup. Developer questions should be sent to the wtp-incubator mailing list.
+
Committers watch and hang out on a variety of eclipse resources channels. Include #eclipse irc channel on freenode.net. Also, we monitor the [https://www.eclipse.org/forums/index.php?t=thread&frm_id=235 Eclipse Community Forum] and the [news://news.eclipse.org/eclipse.vex eclipse.vex] newsgroup. Developer questions should be sent to the [https://dev.eclipse.org/mailman/listinfo/mylyn-vex-dev mylyn-vex-dev mailing list].
  
 
= Vex Committer Calls =
 
= Vex Committer Calls =

Revision as of 07:08, 12 July 2014

Project Manifesto

  1. All new enhancements will be unit tested.
  2. First learn rule number 1.

Getting the Source

The source code for Vex resides in the Mylyn Docs Vex Git repository. For general information about how to use Git see the EGit User Guide. The names of the Vex plug-in projects are all prefixed with: org.eclipse.vex.

Setup a Workspace

Vex is available through the Eclipse Oomph Installer. To setup a workspace, do the following steps:

  1. Get the Eclipse Oomph Installer, unzip it and start it.
  2. Select "Eclipse Standard/SDK" on the "Product" page and press "Next"
  3. Double-click on "Vex" on the "Projects" page and press "Next"
  4. Fill out the "Variables" page as it fits best to your desired environment and press "Next"
  5. Check the planned bootstrap tasks on the "Confirmation" page and press "Next" to start the actual installation of the IDE
  6. Press "Finish" after the installation is done.

It will take a moment until your new Vex IDE is started, just be patient. Some seconds after the start, again a installation wizard is opened where you have to confirm the configuration tasks for the new IDE.

Patches and Bug Fixes

Please provide us your contributions through the Gerrit Code Review system of the Eclipse Foundation. For more information about how to use Gerrit, please see Development_Resources/Contributing_via_Git.

Bug fixes that come with unit tests are more likely to be reviewed sooner than those that do not come with unit tests. Patches over 250 lines of code will have to be sent through eclipse IP review.

With that said, we are actively seeking new enhancements and patches for Vex.

Build

Vex is build with Tycho (see "Tycho - Building Eclipse Plugins with Maven") on its own Hudson instance.

Getting Help

Committers watch and hang out on a variety of eclipse resources channels. Include #eclipse irc channel on freenode.net. Also, we monitor the Eclipse Community Forum and the eclipse.vex newsgroup. Developer questions should be sent to the mylyn-vex-dev mailing list.

Vex Committer Calls