Difference between revisions of "Lyo/ContributorsGettingStarted"
< Lyo
(New page: 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 ...) |
(eclipse ide notice) |
||
| (54 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| + | = Contributing to Eclipse Lyo = | ||
| + | |||
This guide is to help you get started contributing to the Eclipse Lyo project. | This guide is to help you get started contributing to the Eclipse Lyo project. | ||
| − | == | + | == Getting started == |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | In order to get your commit merged into master, you need to follow a few steps. | |
| − | + | '''Before working on the code''' | |
| − | + | * Register a [https://accounts.eclipse.org/ new Eclipse account] | |
| + | * Search the [https://bugs.eclipse.org/bugs/query.cgi?format=specific existing bug list]. Look for bugs with ANY status under LYO product and if none matches your problem, [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Lyo file a new bug] on Bugilla '''before working on your contribution'''. | ||
| + | * If you want to discuss your idea before (and after) filing a bug, join the [https://dev.eclipse.org/mailman/listinfo/lyo-dev lyo-dev mailing list]. | ||
| + | * Accept and sign the [https://www.eclipse.org/legal/ECA.php ECA]. Instructions on how to sign are on the right side of the page. | ||
| − | + | '''Developing a change''' | |
| − | + | ||
| − | + | ||
| − | + | * [https://git.eclipse.org/r/#/admin/projects/?filter=lyo Find the corresponding Gerrit project] and clone it using the command to ''Clone with <code>commit-msg</code> hook''. | |
| + | * Create a new Git brach from <code>master</code> (best practice is to create a branch <code>b12345-gitignore</code> for a bug ''Bug 12345 .gitignore file missing''). | ||
| + | * Make your changes to the code. | ||
| + | * Make sure you update the license header of the files you modify. | ||
| + | * '''Make a single commit containing all your changes.''' | ||
| + | * Start the first line of your commit message with ''Bug 12345 -'' for a patch that is addressing ''Bug 12345''. | ||
| + | * Make sure to [https://stackoverflow.com/questions/13457203/how-to-add-the-signed-off-by-field-in-the-git-patch include Singed-off-by] line in your commit message (by doing this, you are signing off on a [https://www.eclipse.org/legal/DCO.php Developer Certificate of Origin]). '''Commits without a Singed-off-by line are not accepted!''' | ||
| − | + | <blockquote>If you have accidentally made more than one commit, you need to [https://stackoverflow.com/questions/5189560/squash-my-last-x-commits-together-using-git squash the commits]. If you need to update your commit (in case you forgot something or received a feedback you need to address), [https://www.atlassian.com/git/tutorials/rewriting-history#git-commit--amend amend your commit]. [More Git tips are on Lyo wiki] (https://wiki.eclipse.org/Lyo/GitTips) | |
| − | + | </blockquote> | |
| + | '''Submitting the change for review''' | ||
| − | * | + | * Submit your commit for the review: |
| − | * | + | * [http://www.vogella.com/tutorials/Gerrit/article.html#gerritreview_configuration Via Eclipse EGit] |
| − | + | * Via the command line: <code>git push origin HEAD:refs/for/master</code>. [https://www.mediawiki.org/wiki/Gerrit/git-review git-review] is recommended for frequent users. | |
| − | + | ||
| − | * | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| + | See [https://git.eclipse.org/r/Documentation/intro-user.html Gerrit User Guide] for more information. | ||
| − | + | == Eclipse IDE notice == | |
| − | + | You can import these projects in Eclipse, they should be loaded via the <code>File > Import > Maven > Existing Maven Projects</code>. This will automatically create the <code>.project</code>, <code>.classpath</code> and <code>.setting</code> files from the <code>pom.xml</code> files. This will ensure the Eclipse project and the Maven POM are in sync. As a side effect, the Eclipse projects will be displayed using their Maven <code>artifactId</code>, not the parent folder name. So <code>org.eclipse.lyo.core</code> will be displayed as <code>oslc4j-core</code>. In the future, we plan to ensure the eclipse project name and the artifactId are the same and will be avoiding the use of Java package-like names as project names, but these will be breaking changes and will need to be discussed beforehand. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Latest revision as of 09:04, 3 August 2017
Contributing to Eclipse Lyo
This guide is to help you get started contributing to the Eclipse Lyo project.
Getting started
In order to get your commit merged into master, you need to follow a few steps.
Before working on the code
- Register a new Eclipse account
- Search the existing bug list. Look for bugs with ANY status under LYO product and if none matches your problem, file a new bug on Bugilla before working on your contribution.
- If you want to discuss your idea before (and after) filing a bug, join the lyo-dev mailing list.
- Accept and sign the ECA. Instructions on how to sign are on the right side of the page.
Developing a change
- Find the corresponding Gerrit project and clone it using the command to Clone with
commit-msghook. - Create a new Git brach from
master(best practice is to create a branchb12345-gitignorefor a bug Bug 12345 .gitignore file missing). - Make your changes to the code.
- Make sure you update the license header of the files you modify.
- Make a single commit containing all your changes.
- Start the first line of your commit message with Bug 12345 - for a patch that is addressing Bug 12345.
- Make sure to include Singed-off-by line in your commit message (by doing this, you are signing off on a Developer Certificate of Origin). Commits without a Singed-off-by line are not accepted!
If you have accidentally made more than one commit, you need to squash the commits. If you need to update your commit (in case you forgot something or received a feedback you need to address), amend your commit. [More Git tips are on Lyo wiki] (https://wiki.eclipse.org/Lyo/GitTips)
Submitting the change for review
- Submit your commit for the review:
- Via Eclipse EGit
- Via the command line:
git push origin HEAD:refs/for/master. git-review is recommended for frequent users.
See Gerrit User Guide for more information.
Eclipse IDE notice
You can import these projects in Eclipse, they should be loaded via the File > Import > Maven > Existing Maven Projects. This will automatically create the .project, .classpath and .setting files from the pom.xml files. This will ensure the Eclipse project and the Maven POM are in sync. As a side effect, the Eclipse projects will be displayed using their Maven artifactId, not the parent folder name. So org.eclipse.lyo.core will be displayed as oslc4j-core. In the future, we plan to ensure the eclipse project name and the artifactId are the same and will be avoiding the use of Java package-like names as project names, but these will be breaking changes and will need to be discussed beforehand.