Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Nebula/Contributions/Setup IDE"

(Import our PSF File)
(Three Ways to Setup Your IDE)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Get your Eclipse Credentials ==
 
== Get your Eclipse Credentials ==
 
To provide patches to Nebula, create an [https://accounts.eclipse.org/user/register Eclipse account], sign the ECA and get a [https://github.com/join GitHub account].
 
To provide patches to Nebula, create an [https://accounts.eclipse.org/user/register Eclipse account], sign the ECA and get a [https://github.com/join GitHub account].
 +
 +
=== Create a GitHub Account ===
 +
[https://github.com/join Create a GitHub account] (or use your existing one)
  
 
=== Create an Eclipse Account ===
 
=== Create an Eclipse Account ===
[https://accounts.eclipse.org/user/register Create an Eclipse Account] (or use your existing one)
+
[https://accounts.eclipse.org/user/register Create an Eclipse Account] (or use your existing one) and set your GitHub account (this will tell Eclipse who you are on GitHub)
 +
 
 
=== Sign the ECA ===
 
=== Sign the ECA ===
 
[https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#Eclipse_Contributor_Agreement Sign the ECA]
 
[https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#Eclipse_Contributor_Agreement Sign the ECA]
=== Create a GitHub Account ===
 
[https://github.com/join Create a GitHub account] (or use your existing one)
 
  
 
== Three Ways to Setup Your IDE ==
 
== Three Ways to Setup Your IDE ==
To setup your IDE there are three possibilities. Using Oomph is the easiest for newcomers.
+
To setup your IDE there are three possibilities. Using the project set file is the easiest for newcomers.
  
# Use Oomph
 
 
# Import our PSF file
 
# Import our PSF file
 +
# Use Oomph
 
# Setup manually
 
# Setup manually
  
=== Import with Oomph ===
+
=== 1. Import Project Set File ===
Use the Eclipse installer or, if you have already installed Oomph, use the Oomph import wizard and select Nebula. If Nebula is not in the list, add this setup file.
+
In an empty workspace select the URL below and open File/Import... en find Team/Team Project Set. Paste the url in the wizard that appears and lean back.  
<br/>
+
[https://raw.githubusercontent.com/eclipse/nebula/master/oomph.setup https://raw.githubusercontent.com/eclipse/nebula/master/oomph.setup]
+
  
=== Import Project Set File ===
+
The PSF file will import all wizards and assign projects to [https://help.eclipse.org/photon/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Fconcepts%2Fcworkset.htm working sets] for your convenience.
In an empty workspace select the URL below and open File/Import... en find Team/Team Project Set. Paste the url in the wizard that appears and lean back.
+
  
The wizard will fail if git was not setup correctly or if the nebula git directory already exists or if any of the projects already exists. In this case, install git, remove the nebula directory, run with a clean workspace or any combination of the previous options.
+
The wizard will fail if git was not setup correctly or if the nebula git directory already exist or if any of the projects already exists. In this case, install git, remove the nebula directory, run with a clean workspace or any combination of the previous options.
  
[https://raw.githubusercontent.com/eclipse/nebula/master/releng/org.eclipse.nebula.feature/Nebula_All.psf]
+
[https://raw.githubusercontent.com/eclipse/nebula/master/releng/org.eclipse.nebula.feature/Nebula_All.psf https://raw.githubusercontent.com/eclipse/nebula/master/releng/org.eclipse.nebula.feature/Nebula_All.psf]
  
=== Clone the GIT Repo Manually ===
 
The Nebula repository on GitHub is here: https://github.com/eclipse/nebula. For example:
 
  
  C:\>git clone https://github.com/eclipse/nebula.git
+
=== 2. Import with Oomph ===
 +
Use the Eclipse installer or, if you have already installed Oomph, use the Oomph import wizard and select Nebula. If Nebula is not in the list, add this setup file.
 +
<br/>
 +
[https://raw.githubusercontent.com/eclipse/nebula/master/oomph.setup https://raw.githubusercontent.com/eclipse/nebula/master/oomph.setup]
  
=== Forking and Pull Requests ===
 
 
To be able to submit a Pull Request you need to fork the Nebula repository. See GitHub's extensive documentation on working with Pull Requests. Start with the [https://help.github.com/articles/github-flow/ GitHub flow overview] and then continue with the rest of the [https://help.github.com/categories/collaborating-with-issues-and-pull-requests/ documentation].
 
 
== Start Eclipse ==
 
Open your Eclipse IDE and open the Git perspective
 
 
==== Add Local Git Repo ====
 
Add a local Git repository and find your freshly created repo
 
  
 +
=== 3. Clone the GIT Repo Manually ===
 +
The Nebula repository on GitHub is here: https://github.com/eclipse/nebula. For example:
  
==== Import Projects ====
+
  C:\Users\You\git>git clone https://github.com/eclipse/nebula.git
If you did not use the psf file then you have to use git to import the relevant projects. Import the widgets you want to work on from the '''''widgets''''' directory and import the first two example projects from the example directory.
+
  
[[Image:nebula_proj_1.png]]
+
== Find the Nebula Examples View ==
  
==== Run Eclipse ====
+
=== Run Eclipse ===
 
Create a new run configuration and press Run
 
Create a new run configuration and press Run
  
 
[[Image:nebula_ide3.png]]
 
[[Image:nebula_ide3.png]]
  
==== Open Nebula Perspective ====
+
=== Open Nebula Perspective ===
 
Open the Nebula perspective and find the example view for your widget and test your changes. You can also test your changes by using the widget in a snippet or in your own project.
 
Open the Nebula perspective and find the example view for your widget and test your changes. You can also test your changes by using the widget in a snippet or in your own project.

Latest revision as of 17:25, 9 November 2018

Get your Eclipse Credentials

To provide patches to Nebula, create an Eclipse account, sign the ECA and get a GitHub account.

Create a GitHub Account

Create a GitHub account (or use your existing one)

Create an Eclipse Account

Create an Eclipse Account (or use your existing one) and set your GitHub account (this will tell Eclipse who you are on GitHub)

Sign the ECA

Sign the ECA

Three Ways to Setup Your IDE

To setup your IDE there are three possibilities. Using the project set file is the easiest for newcomers.

  1. Import our PSF file
  2. Use Oomph
  3. Setup manually

1. Import Project Set File

In an empty workspace select the URL below and open File/Import... en find Team/Team Project Set. Paste the url in the wizard that appears and lean back.

The PSF file will import all wizards and assign projects to working sets for your convenience.

The wizard will fail if git was not setup correctly or if the nebula git directory already exist or if any of the projects already exists. In this case, install git, remove the nebula directory, run with a clean workspace or any combination of the previous options.

https://raw.githubusercontent.com/eclipse/nebula/master/releng/org.eclipse.nebula.feature/Nebula_All.psf


2. Import with Oomph

Use the Eclipse installer or, if you have already installed Oomph, use the Oomph import wizard and select Nebula. If Nebula is not in the list, add this setup file.
https://raw.githubusercontent.com/eclipse/nebula/master/oomph.setup


3. Clone the GIT Repo Manually

The Nebula repository on GitHub is here: https://github.com/eclipse/nebula. For example:

 C:\Users\You\git>git clone https://github.com/eclipse/nebula.git

Find the Nebula Examples View

Run Eclipse

Create a new run configuration and press Run

Nebula ide3.png

Open Nebula Perspective

Open the Nebula perspective and find the example view for your widget and test your changes. You can also test your changes by using the widget in a snippet or in your own project.

Back to the top