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 "Lyo/ContributorsGettingStarted"

< Lyo
(Lyo contribution process)
Line 18: Line 18:
 
You're ready to contribute a bug fix or some new functionality to Lyo?  Great.  Here's what you need to do:
 
You're ready to contribute a bug fix or some new functionality to Lyo?  Great.  Here's what you need to do:
  
1 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.
1 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]
1 Code your change - make sure you update any copyright headers as needed.
+
* Code your change - make sure you update any copyright headers as needed.
1 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
1 Push the code to the appropriate Lyo Gerrit repository.   
+
* Push the code to the appropriate Lyo Gerrit repository.   
1 Visit the [https://git.eclipse.org/r/ Gerrit review instance] and login  
+
* Visit the [https://git.eclipse.org/r/ Gerrit review instance] and login  
1 Click on your new review request and add some reviewers
+
* Click on your new review request and add some reviewers
   1 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
   1 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
1 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."
1 (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 and approved, there is nothing more for you to do

Revision as of 20:48, 26 April 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. Please see [Gerrit | the Eclipse Gerrit guide ] for information on configuring EGit or the command line to push to the Eclipse Gerrit instance.

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
  • Code your change - make sure you update any copyright headers as needed.
  • Commit your change locally - all commits must include the Bugzilla number in the commit message
  • 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 and approved, there is nothing more for you to do


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

Copyright © Eclipse Foundation, Inc. All Rights Reserved.