Jump to: navigation, search

Difference between revisions of "Vex/CommitterResources"

< Vex
(Setup a Workspace)
(12 intermediate revisions by 3 users not shown)
Line 5: Line 5:
 
=Getting the Source=
 
=Getting the Source=
  
The source code for Vex resides in the incubator/sourceediting module within the /gitroot/webtools Git repository. For general information about how to use Git see the [[EGit/User Guide|EGit User Guide]].
+
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|EGit User Guide]]. The names of the Vex plug-in projects are all prefixed with: ''org.eclipse.vex''.
 
+
The names of the Vex plug-in projects are all prefixed with: ''org.eclipse.wst.xml.vex''. The following is a list of where specific items can be found:
+
* development - the configuration of the automated builds
+
* plugins - the actual ui and core plugins.
+
* documentation - eclipse help plugins that contain both user and developer documentation.
+
* tests - unit test plugins.
+
* features - features used mainly for update site installation.
+
  
 
== Setup a Workspace ==
 
== Setup a Workspace ==
 
* Install the EGit team provider
 
* Install the EGit team provider
* Configure and clone the webtools/incubator Git repository including the branch ''vex-dev'':
+
 
 
For committers:
 
For committers:
     ssh://<your_username>@git.eclipse.org/gitroot/webtools/org.eclipse.webtools.incubator.git
+
* 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:
 
For other contributors:
     git://git.eclipse.org/gitroot/webtools/org.eclipse.webtools.incubator.git
+
* Import the Team Project Set from
* Import all projects with the prefix ''org.eclipse.wst.xml.vex'' into your workspace
+
     http://git.eclipse.org/c/mylyn/org.eclipse.mylyn.docs.vex.git/plain/org.eclipse.vex.releng/vex.psf
* Checkout the branch ''vex-dev''
+
 
* Configure the target definition ''Vex Helios'', which is stored in the releng plug-in
+
For all (after cloning the Git repository)
* Use the launch configuration ''Vex'' to start a runtime workbench which includes Vex
+
* 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:
 
Please bear in mind to configure your name and email address in git before cloning the repository:
Line 37: Line 35:
  
 
With that said, we are actively seeking new enhancements and patches for Vex.
 
With that said, we are actively seeking new enhancements and patches for Vex.
 +
 +
== Build ==
 +
 +
With [http://eclipse.org/tycho/ Tycho] see [http://live.eclipse.org/node/1003 "Tycho - Building Eclipse Plugins with Maven"]
  
 
= Getting Help =
 
= Getting Help =
Line 43: Line 45:
  
 
= Vex Committer Calls =
 
= Vex Committer Calls =
 +
* [[Vex/VexCommitterCalls|Vex Committer Calls]]
 +
* [[Vex/VexCommitterCall20110719|2011-07-19]]
 +
* [[Vex/VexCommitterCall20110705|2011-07-05]]
 +
* [[Vex/VexCommitterCall20110426|2011-04-26]]
 +
* [[Vex/VexCommitterCall20110412|2011-04-12]]
 
* [[Vex/VexCommitterCall20110301|2011-03-01]]
 
* [[Vex/VexCommitterCall20110301|2011-03-01]]
 
* [[Vex/VexCommitterCall20110215|2011-02-15]]
 
* [[Vex/VexCommitterCall20110215|2011-02-15]]

Revision as of 17:37, 9 March 2012

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

  • Install the EGit team provider

For committers:

  • 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

Please use a local branch for your changes and create a patch as described in the EGit User Guide. At the moment you have to create one patch for each plug-in that you have changed.

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

With Tycho see "Tycho - Building Eclipse Plugins with Maven"

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.

Vex Committer Calls