Jump to: navigation, search

Difference between revisions of "Lyo/ContributorsGettingStarted"

< Lyo
(Lyo contribution process)
Line 8: Line 8:
  
 
The Lyo project's Git [http://git.eclipse.org/c/lyo repositories].
 
The Lyo project's Git [http://git.eclipse.org/c/lyo repositories].
 
  
 
== Gerrit and Lyo ==
 
== Gerrit and Lyo ==
  
Lyo uses Gerrit to accept, review and approve code contributions from the community.  Please see [Gerrit | the Eclipse Gerrit guide ] for information on configuring EGit or the command line to push to the Eclipse Gerrit instance.  
+
Lyo uses Gerrit to accept, review and approve code contributions from the community.  '''NOTE:'''  Please see [http://wiki.eclipse.org/Gerrit the Eclipse Gerrit guide ] for information on configuring EGit or the command line to push to the Eclipse Gerrit instance.  
 +
The Lyo Gerrit repository URLs to push to are:
 +
 
 +
* OSLC4J core    :  ssh://<userid>@git.eclipse.org:29418/lyo/org.eclipse.lyo.core.git
 +
* OSLC Samples  :  ssh://<userid>@git.eclipse.org:29418/lyo/org.eclipse.lyo.server.git
 +
* OSLC Testsuite :  ssh://<userid>@git.eclipse.org:29418/lyo/org.eclipse.lyo.testsuite.git
 +
* OSLC RIOs        :  ssh://<userid>@git.eclipse.org:29418/lyo/org.eclipse.lyo.rio.git
 +
 
 +
Where <userid> is the user ID received when following the instructions in  [http://wiki.eclipse.org/Gerrit the Eclipse Gerrit guide ].  It is not your Bugzilla user ID.
 +
 
 +
== Building and running the code ==
 +
 
 +
For information on how to build and run the various components in Lyo in a development environment, please see the following guides:
 +
 
 +
* [[Lyo/BuildingOSLC4J | Building and running OSLC4J applications]]
 +
* [[Lyo/BuildRIO | Building and running the reference implementations (RIOs)]]
 +
* [[Lyo/BuildTestSuite| Building and running the OSLC test suite]]
 +
* [[Lyo/BuildBugzilla | Building and running the OSLC Bugzilla sample]]
 +
 
  
 
== Lyo contribution process ==
 
== Lyo contribution process ==
Line 19: Line 36:
  
 
* Make sure there is a [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Lyo Bugzilla bug] open for the work that you are doing.  Make a comment in the bug or on the [mailto:lyo-dev.org mailing list] that you want it assigned to you.
 
* Make sure there is a [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Lyo Bugzilla bug] open for the work that you are doing.  Make a comment in the bug or on the [mailto:lyo-dev.org mailing list] that you want it assigned to you.
* Pull the latest Lyo code from the appropriate [http://git.eclipse.org/c/lyo Lyo git repository]
+
* Pull the latest Lyo code from the appropriate [http://git.eclipse.org/c/lyo Lyo git repository] per the instructions in the "Building and running the code" secition above.
* Code your change - make sure you update any copyright headers as needed.
+
* Code your change - make sure you update any copyright headers as needed.  Use existing source if you need to place a new copyright header.  Make sure it references both the EPL and EDL licenses.
* Commit your change locally - all commits must include the Bugzilla number in the commit message
+
* Commit your change locally - all commits must include the Bugzilla number in the commit message.  You commit must have the Gerrit Change-Id string in the last paragraph.
 
* Push the code to the appropriate Lyo Gerrit repository.   
 
* Push the code to the appropriate Lyo Gerrit repository.   
 
* Visit the [https://git.eclipse.org/r/ Gerrit review instance] and login  
 
* Visit the [https://git.eclipse.org/r/ Gerrit review instance] and login  
 
* Click on your new review request and add some reviewers
 
* Click on your new review request and add some reviewers
   * Add at least one of the project committers (fiedler.mf@gmail-dot-com or spadgett@us-dot-ibm-dot-com are good choices) as a reviewer
+
   ** Add at least one of the project committers (fiedler.mf@gmail-dot-com or spadgett@us-dot-ibm-dot-com are good choices) as a reviewer
   * Add any others you think would be able to provide a valuable review
+
   ** Add any others you think would be able to provide a valuable review
 
* Edit the Bugzilla bug tracking this work and add this statement (only if it is true!!):  "I wrote all this code and have the rights to contribute it to Eclipse under the eclipse.org web site terms of use."
 
* Edit the Bugzilla bug tracking this work and add this statement (only if it is true!!):  "I wrote all this code and have the rights to contribute it to Eclipse under the eclipse.org web site terms of use."
 
* (Optional) send a notification to the lyo-dev mailing list that the change is ready for review.
 
* (Optional) send a notification to the lyo-dev mailing list that the change is ready for review.
  
After the change is reviewed and approved, there is nothing more for you to do
+
After the change is reviewed, it may require additional work or amendment based on the review comments.  See [http://wiki.eclipse.org/EGit/User_Guide#Amending_Commits the EGit User's Guide] for information on amending commits.
 +
 
 +
Once your change is approved, there is nothing more for you to do - the committers will push the change to the appropriate repository and others can then fetch or pull it.
  
  
  
 
Older instructions on using GitHub with Lyo can be found [Lyo/LyoGitHub | here ]
 
Older instructions on using GitHub with Lyo can be found [Lyo/LyoGitHub | here ]

Revision as of 19:19, 1 May 2012

This guide is to help you get started contributing to the Eclipse Lyo project.

Git repositories

Lyo uses Git for source control. Getting both EGit for Eclipse and the git command line tools are recommended.

The Lyo project's Git repositories.

Gerrit and Lyo

Lyo uses Gerrit to accept, review and approve code contributions from the community. NOTE: Please see the Eclipse Gerrit guide for information on configuring EGit or the command line to push to the Eclipse Gerrit instance. The Lyo Gerrit repository URLs to push to are:

  • OSLC4J core  : ssh://<userid>@git.eclipse.org:29418/lyo/org.eclipse.lyo.core.git
  • OSLC Samples  : ssh://<userid>@git.eclipse.org:29418/lyo/org.eclipse.lyo.server.git
  • OSLC Testsuite : ssh://<userid>@git.eclipse.org:29418/lyo/org.eclipse.lyo.testsuite.git
  • OSLC RIOs  : ssh://<userid>@git.eclipse.org:29418/lyo/org.eclipse.lyo.rio.git

Where <userid> is the user ID received when following the instructions in the Eclipse Gerrit guide . It is not your Bugzilla user ID.

Building and running the code

For information on how to build and run the various components in Lyo in a development environment, please see the following guides:


Lyo contribution process

You're ready to contribute a bug fix or some new functionality to Lyo? Great. Here's what you need to do:

  • Make sure there is a Bugzilla bug open for the work that you are doing. Make a comment in the bug or on the mailing list that you want it assigned to you.
  • Pull the latest Lyo code from the appropriate Lyo git repository per the instructions in the "Building and running the code" secition above.
  • Code your change - make sure you update any copyright headers as needed. Use existing source if you need to place a new copyright header. Make sure it references both the EPL and EDL licenses.
  • Commit your change locally - all commits must include the Bugzilla number in the commit message. You commit must have the Gerrit Change-Id string in the last paragraph.
  • Push the code to the appropriate Lyo Gerrit repository.
  • Visit the Gerrit review instance and login
  • Click on your new review request and add some reviewers
  ** Add at least one of the project committers (fiedler.mf@gmail-dot-com or spadgett@us-dot-ibm-dot-com are good choices) as a reviewer
  ** Add any others you think would be able to provide a valuable review
  • Edit the Bugzilla bug tracking this work and add this statement (only if it is true!!): "I wrote all this code and have the rights to contribute it to Eclipse under the eclipse.org web site terms of use."
  • (Optional) send a notification to the lyo-dev mailing list that the change is ready for review.

After the change is reviewed, it may require additional work or amendment based on the review comments. See the EGit User's Guide for information on amending commits.

Once your change is approved, there is nothing more for you to do - the committers will push the change to the appropriate repository and others can then fetch or pull it.


Older instructions on using GitHub with Lyo can be found [Lyo/LyoGitHub | here ]