Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "EGit/Contributor Guide"

(Contributing Patches)
Line 42: Line 42:
  
 
Or, create a [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EGit new bug] and attach a Git formatted patch file, as produced by the `git format-patch` tool.
 
Or, create a [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EGit 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:
 +
<pre style="width: 60em">
 +
scp -p -P 29418 username@egit.eclipse.org:hooks/commit-msg .git/hooks
 +
</pre>
 +
 +
To create a new change:
 +
<pre style="width: 60em">
 +
git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master
 +
</pre>
 +
 +
To update an existing change with a new commit:
 +
<pre style="width: 60em">
 +
git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master
 +
</pre>
 +
This works because Gerrit links the new commit to the prior change based upon the Commit-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 Commit-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].

Revision as of 14:01, 2 October 2009

Warning2.png
Draft Content
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 ListForumsIRCmattermost
Issues
OpenHelp WantedBug Day
Contribute
Browse SourceProject Set File

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

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

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 Commit-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 Commit-Id footer, you should read the Gerrit documentation on change-id lines and replacing changes.

Back to the top