Skip to content

Commit

Permalink
Use the Oomph setup configuration is the contribution documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
merks authored and LorenzoBettini committed May 12, 2024
1 parent 4a00289 commit cc5f94f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,19 @@ All committers should feel responsible to read incoming issues. When you read a
## Set up your Eclipse Workspace
Before starting the setup process, make sure that you have both an [Eclipse](https://accounts.eclipse.org/user/register) and a [GitHub](https://github.com/join) account.

The easiest way to set up a Xtext development environment is to use the following automated Oomph setup configuration link:

[![Create Eclipse Development Environment for Xtext](https://download.eclipse.org/oomph/www/setups/svg/Xtext.svg)](https://www.eclipse.org/setups/installer/?url=https://raw.githubusercontent.com/eclipse/xtext/main/releng/org.eclipse.xtext.contributor/XtextConfiguration.setup&show=true "Click to open Eclipse-Installer Auto Launch or drag onto your running installer's title area")

Alternatively you can do those steps manually as follows:

1. Download and start the [Eclipse Installer](https://wiki.eclipse.org/Eclipse_Oomph_Installer).
1. On the initial page, click on the *Switch to Advanced Mode* button in the top right.
1. On the *Product* page, select *Eclipse IDE for Eclipse Committers*.
1. On the *Projects* page, select the *Xtext* node.
1. Choose your preferred installation settings on the *Variables* page. Enter credentials for your Eclipse and GitHub accounts. If you don't have an SSH key registered with GitHub then make sure that you select `HTTPS (read-only, anonymous)` or `HTTPS (read-write)` for the GitHub repository entries.
1. Finish the wizard, drink a cup of coffee, and watch how your Xtext development environment is assembled.

NOTE for Windows users: after the workspace setup has finished, some files in some `xtend-gen` folders will be detected as "dirty" by Git. That is due to some tests using multi-line strings (not multi-line template strings); unfortunately, we still haven't found a solution to this problem.

## Contribute via a Fork
You need a [GitHub](https://github.com/join) and an [Eclipse](https://accounts.eclipse.org/user/register) account for which you signed the [Eclipse Contributor Agreement](https://accounts.eclipse.org/user/login?destination=user/eca).

Expand Down

0 comments on commit cc5f94f

Please sign in to comment.