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.
Vex/CommitterResources
Contents
Project Manifesto
- All new enhancements will be unit tested.
- 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.