|
|
(38 intermediate revisions by 5 users not shown) |
Line 1: |
Line 1: |
− | {{Xtext}} {{:DocumentationGuidelines/DraftHeader}} | + | {{Xtext}} |
− | == Prerequisites ==
| + | |
− | === User Account ===
| + | |
− | We use [https://git.eclipse.org/r/ eclipse gerrit review server]. To use the review server a few steps are required:
| + | |
− | * Register an Eclipse.org account at [https://dev.eclipse.org/site_login/createaccount.php dev.eclipse.org]. The same account is used for [https://bugs.eclipse.org/bugs Bugzilla] and [https://git.eclipse.org/r Gerrit]. If you are an Eclipse committer you already have one.
| + | |
− | * [https://git.eclipse.org/r/#settings,http-password Define a username]
| + | |
− | * [https://git.eclipse.org/r/#settings,ssh-keys Upload your public ssh-key] for authentication
| + | |
− | === Eclipse Distribution ===
| + | |
− | Download Full eclipse from [http://www.eclipse.org/Xtext/download.html Xtext website] or use the [http://www.eclipse.org/downloads/ eclipse DSL Package]
| + | |
− | <br><br>
| + | |
| | | |
− | == Let Buckminster setup your Xcontributor environment ==
| + | The Xtext Contributor Guide is now maintained in the [https://github.com/eclipse/xtext/blob/master/CONTRIBUTING.md Xtext GitHub repository]. |
− | | + | |
− | We provide an ant script which installs and runs Buckminster. Buckminster will do the most off necessary steps to crete a contributor workspace for you.
| + | |
− | | + | |
− | What does this script do in detail:
| + | |
− | | + | |
− | *create an eclipse workspace
| + | |
− | *clone the Xtext git repository
| + | |
− | *populate workspace with necessary projects
| + | |
− | *create and set api baseline
| + | |
− | *create and set a target platform
| + | |
− | *set some important workspace settings
| + | |
− | *perform gerrit setup
| + | |
− | | + | |
− | === Run the script ===
| + | |
− | | + | |
− | Run the ant script located here http://git.eclipse.org/c/tmf/org.eclipse.xtext.git/plain/devtools/org.eclipse.xtext.contributor/workspace.ant In unix you can use following commands:
| + | |
− | {{codeblock|wget -N http://git.eclipse.org/c/tmf/org.eclipse.xtext.git/plain/devtools/org.eclipse.xtext.contributor/workspace.ant; ant -f workspace.ant}}
| + | |
− | === Start eclipse ===
| + | |
− | Start your eclipse and choose ${user.home}/workspaces/xtext-sources as eclipse workspace
| + | |
− | === Setup working sets ===
| + | |
− | * In "Package Explorer" - view, select "Top level elements -> Working sets"
| + | |
− | * Select File -> Import -> Team -> Team Project Set.
| + | |
− | * Point to the following URL http://git.eclipse.org/c/tmf/org.eclipse.xtext.git/plain/devtools/org.eclipse.xtext.contributor/projectSet.psf
| + | |
− | * Perform import
| + | |
− | <br> <br>
| + | |
− | == Xcontributor environment - Do it yourself ==
| + | |
− | | + | |
− | TODO
| + | |
− | | + | |
− | == Browse Sources Online ==
| + | |
− | Xtext and Xtend are hosted in Git. You can browse the repository in cgit here [http://git.eclipse.org/c/tmf/org.eclipse.xtext.git/ Xtext/Xtend repository]. | + | |
− | <br>
| + | |