Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EGit/Contributor Guide"
m (→Obtaining Sources) |
(→Gerrit Code Review Cheatsheet) |
||
| Line 47: | Line 47: | ||
= Gerrit Code Review Cheatsheet = | = Gerrit Code Review Cheatsheet = | ||
| − | Install the commit-msg hook in your repository: | + | ''Install the commit-msg hook in your repository:'' |
<pre style="width: 60em"> | <pre style="width: 60em"> | ||
scp -p -P 29418 username@egit.eclipse.org:hooks/commit-msg .git/hooks | scp -p -P 29418 username@egit.eclipse.org:hooks/commit-msg .git/hooks | ||
</pre> | </pre> | ||
| − | To create a new change: | + | ''To create a new change:'' |
<pre style="width: 60em"> | <pre style="width: 60em"> | ||
git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master | git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master | ||
</pre> | </pre> | ||
| − | To update an existing change with a new commit: | + | ''To update an existing change with a new commit:'' |
<pre style="width: 60em"> | <pre style="width: 60em"> | ||
git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master | git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master | ||
</pre> | </pre> | ||
This works because Gerrit links the new commit to the prior change based upon the Change-Id footer in the commit message. (This is automatically generated by the commit-msg hook you installed above.) If you refuse to use the commit-msg hook, or don't have a Change-Id footer, you should read the Gerrit documentation on [http://gerrit.googlecode.com/svn/documentation/2.0/user-changeid.html change-id lines] and [http://gerrit.googlecode.com/svn/documentation/2.0/user-upload.html#push_replace replacing changes]. | This works because Gerrit links the new commit to the prior change based upon the Change-Id footer in the commit message. (This is automatically generated by the commit-msg hook you installed above.) If you refuse to use the commit-msg hook, or don't have a Change-Id footer, you should read the Gerrit documentation on [http://gerrit.googlecode.com/svn/documentation/2.0/user-changeid.html change-id lines] and [http://gerrit.googlecode.com/svn/documentation/2.0/user-upload.html#push_replace replacing changes]. | ||
| + | |||
| + | ''To approve a change:'' | ||
| + | * Click on Publish Comments | ||
| + | * Vote with the radio buttons | ||
| + | |||
| + | ''Code Review:'' | ||
| + | The code review category indicates your opinion on the quality of the code, and how well it fits within the purpose of the existing surrounding code. A +2 vote from any committer is required before submission can occur. A -2 vote from any committer will block submission. | ||
| + | |||
| + | ''IP Review:'' | ||
| + | The IP review category indicates whether or not the change has been properly logged under the [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf eclipse IP process]. Under that process, any committer should mark his/her change +1 if they were the sole author of the change. For any other change, a committer should only mark +1 after ensuring the corresponding bug in Bugzilla has been updated with the iplog flag, or the corresponding CQ has been marked checkintocvs. A +1 vote is required to submit a change, while a -1 vote will block submission. | ||
= Libraries from Orbit = | = Libraries from Orbit = | ||
Revision as of 10:05, 8 October 2009
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.
| EGit | |
| Website | |
| Download | |
| Community | |
| Mailing List • Forums • IRC • mattermost | |
| Issues | |
| Open • Help Wanted • Bug Day | |
| Contribute | |
| Browse Source • Project Set File |
Contents
Obtaining Sources
EGit and JGit are currently self hosted in Git. To obtain a copy of each repository:
From the command line:
git clone git://egit.eclipse.org/egit/parallelip-jgit.git jgit git clone git://egit.eclipse.org/egit/parallelip-egit.git egit
From an installed EGit plugin:
- File > Import > Git Repository
- Enter URL
git://egit.eclipse.org/egit/parallelip-jgit.git
- Import projects
- File > Import > Git Repository
- Enter URL
git://egit.eclipse.org/egit/parallelip-egit.git
- Import projects
- Browse the repositories in gitweb
Contributing Patches
Review the following style guides:
Currently the project is alpha-testing Gerrit Code Review for Git based patch submission and review. To use the alpha testing instance hosted at eclipse.org:
- Register a user account
- Add one or more public SSH keys
- Execute SSH once to accept the host key (or copy it from the registration web page)
ssh -p 29418 username@egit.eclipse.org
- Upload your patch from Git to the target project:
git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master
- Visit our Gerrit Code Review instance to start reviewing
Or, create a new bug and attach a Git formatted patch file, as produced by the `git format-patch` tool.
Gerrit Code Review Cheatsheet
Install the commit-msg hook in your repository:
scp -p -P 29418 username@egit.eclipse.org:hooks/commit-msg .git/hooks
To create a new change:
git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master
To update an existing change with a new commit:
git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master
This works because Gerrit links the new commit to the prior change based upon the Change-Id footer in the commit message. (This is automatically generated by the commit-msg hook you installed above.) If you refuse to use the commit-msg hook, or don't have a Change-Id footer, you should read the Gerrit documentation on change-id lines and replacing changes.
To approve a change:
- Click on Publish Comments
- Vote with the radio buttons
Code Review: The code review category indicates your opinion on the quality of the code, and how well it fits within the purpose of the existing surrounding code. A +2 vote from any committer is required before submission can occur. A -2 vote from any committer will block submission.
IP Review: The IP review category indicates whether or not the change has been properly logged under the eclipse IP process. Under that process, any committer should mark his/her change +1 if they were the sole author of the change. For any other change, a committer should only mark +1 after ensuring the corresponding bug in Bugzilla has been updated with the iplog flag, or the corresponding CQ has been marked checkintocvs. A +1 vote is required to submit a change, while a -1 vote will block submission.
Libraries from Orbit
com.jcraft.jsch
- File > Import > CVS > Projects from CVS
- Select URL :pserver:anonymous@dev.eclipse.org/cvsroot/tools
- Use module org.eclipse.orbit/com.jcraft.jsch
- Finish
- Right click on the project > Team > Switch to another branch
- Select tag from following list
- Refresh Tags
- Branches > v0_1_41
org.kohsuke.args4j
- File > Import > CVS > Projects from CVS
- Select URL :pserver:anonymous@dev.eclipse.org/cvsroot/tools
- Use module org.eclipse.orbit/org.kohsuke.args4j
- Finish
- Right click on the project > Team > Switch to another branch
- Select tag from following list
- Refresh Tags
- Branches > v2_0_12
javax.servlet
- File > Import > CVS > Projects from CVS
- Select URL :pserver:anonymous@dev.eclipse.org/cvsroot/tools
- Use module org.eclipse.orbit/javax.servlet
- Finish
- Right click on the project > Team > Switch to another branch
- Select tag from following list
- Refresh Tags
- Branches > v2_5_0