README.md

# Eclipse EGit GitHub Connector

_EGit GitHub Connector_ is an Eclipse plugin for working with Git repositories
hosted on Github. It is based on the _JGit_ library, which is a Git implementation
in pure Java, and integrates with EGit, which is the Eclipse Git Team Provider, and
uses the Mylyn framework.

This package is licensed under the _EPL 2.0_ . Please refer to the `LICENSE` file
for the complete license.

## Compatibility

- In general, EGit supports at least the latest two Eclipse releases.
  For details, please see https://wiki.eclipse.org/EGit/FAQ

- Newer version of EGit may implement new functionality, remove
  existing functions and change others without other notice than what
  is written in the commit log and source files themselves.

- The EGit GitHub Connector uses the GitHub REST API v3.

## Installation

Install the EGit GitHub Connector into Eclipse from the official update sites:

* [Latest released version](https://download.eclipse.org/egit/github/updates)
* [Nightly build](https://download.eclipse.org/egit/github/updates-nightly)
  (requires the [EGit Nightly build](https://download.eclipse.org/egit/updates-nightly), too)

See also the [EGit Downloads](https://www.eclipse.org/egit/download/) web page.

## Documentation

[On-line documentation](https://wiki.eclipse.org/EGit/GitHub/User_Guide)
is available, and is also available in the Eclipse Help when the feature is installed.

## Support

Post questions or comments to the egit-dev@eclipse.org mailing list.
You need to be [subscribed](https://dev.eclipse.org/mailman/listinfo/egit-dev)
to post.

Bugs are tracked in [Bugzilla](https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Technology&component=GitHub&list_id=11227256&product=EGit&query_format=advanced). Create new bugs
[here](https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EGit;component=GitHub).


## Contributing

**This project does not use pull requests.**
Pull requests to this GitHub repository will be ignored.

Push patches to Gerrit at https://git.eclipse.org/r/egit/egit-github as explained
in the [EGit Contributor Guide](https://wiki.eclipse.org/EGit/Contributor_Guide).


## About Git

More information about Git, its repository format, and the canonical
C based implementation can be obtained from the [Git website](https://git-scm.com/).