EGit/GitHub/ContributorGuide

EGit also provides tools for integrating with GitHub and Mylyn tasks.

Obtaining Sources

• File > Import > Git > Git Repository
• Enter URI:

https://git.eclipse.org/r/egit/egit-github.git

• Import projects
• Download dependencies:
  • automagically: open file github.target in the Eclipse project org.eclipse.mylyn.github-feature and select 'Set as Target Platform'.

Builds

EGit GitHub builds run on build.eclipse.org via Hudson using

• at least Maven 3.0.0

Hudson

• egit-github Hudson Job

Nightly builds can be obtained via our p2 repository:

• http://download.eclipse.org/egit/github/updates-nightly

Documentation

The EGit GitHub project sources its documentation from the wiki and generates Eclipse help content from it (under the covers, we are using Mylyn WikiText to make this possible). This significantly lowers the barrier for people to contribute documentation to the EGit project. To contribute documentation, simply modify the EGit GitHub User's Guide. Have a look at the Style Guidelines and Eclipse Documentation Style Guide to get some guidance on how to write good documentation. More on that can be found here.

The documentation is contained in the org.eclipse.mylyn.github.doc plug-in. The build-helper.xml drives the generation of the help content. It is integrated into the maven build. The regular maven build of org.eclipse.mylyn.github.doc

$ mvn clean install 

will only package the help content committed to the egit-github repository. To update the help content by downloading the latest documentation from the wiki run

$ mvn clean install -Dupdate.doc

Don't forget to check all the generated help pages and especially all hyperlinks and images before pushing the updated help to the code review system for inclusion into the continuous build.

The aim is to generate new documentation every month or so (or at least before a new version is released). If you're making big changes or want the documentation refreshed, please let us know on the egit-dev mailing list.

Contributing Patches

We accept patches via our Gerrit instance: https://git.eclipse.org/r/

Install the commit-msg hook in your repository:

cd path/to/egit-github
scp -p -P 29418 username@git.eclipse.org:hooks/commit-msg .git/hooks/

Since git can have multiple remotes, you can define one to be used to refer to Gerrit to save typing. Inside of a checked out repository:

cd path/to/egit-github
git config remote.review.url ssh://username@git.eclipse.org:29418/egit/egit-github.git
git config remote.review.push HEAD:refs/for/master

You can now submit review requests from either repository using:

git push review

To learn more about contributing patches to Gerrit, see the main EGit Contributor Guide.