README.md

   1 # Eclipse Git Plugin
   2
   3 _EGit_ is a set of Eclipse plugins for working with Git repositories. It is
   4 based on the _JGit_ library, which is a Git implementation in pure Java. This
   5 package is licensed under the _EPL 2.0_. Please refer to the `LICENSE` file
   6 for the complete license.
   7
   8 ## Components
   9
  10 This package is composed of the following major components.
  11
  12 ### Implementation
  13
  14 - __org.eclipse.egit__: Eclipse branding plugin for _EGit_.
  15 - __org.eclipse.egit.core__: An Eclipse plugin providing an interface to
  16     org.eclipse.jgit and support routines to allow processing in an
  17     Eclipse workspace. It also supplies the team provider implementation.
  18 - __org.eclipse.egit.gitflow__: bundle implementing support for the
  19     [gitflow](https://nvie.com/posts/a-successful-git-branching-model/)
  20     branching model.
  21 - __org.eclipse.egit.gitflow.ui__: bundle implementing a user interface
  22     for the gitflow branching model.
  23 - __org.eclipse.egit.target__: Eclipse target platform providing EGit
  24     3rd party dependencies for the build and for running EGit in Eclipse
  25     workspace.
  26 - __org.eclipse.egit.ui__: An Eclipse plugin providing the user interface on
  27     top of org.eclipse.egit.core.
  28 - __org.eclipse.egit.ui.importer__: An Eclipse plugin integrating the Eclipse
  29     smart import wizard to improve importing projects from Git repositories.
  30
  31 ### Tests
  32
  33 - __org.eclipse.egit.core.junit__: Reusable classes used by _EGit_ tests
  34 - __org.eclipse.egit.core.test__: Unit tests for org.eclipse.egit.core.
  35 - __org.eclipse.egit.gitflow.test__: Unit tests for org.eclipse.egit.gitflow.
  36 - __org.eclipse.egit.ui.importer.test__: UI tests for org.eclipse.egit.ui.smartimport.
  37 - __org.eclipse.egit.ui.test__: UI tests for org.eclipse.egit.ui.
  38
  39 ### Packaging
  40
  41 - __org.eclipse.egit.doc__: Documentation bundle packaging EGit documentation.
  42     Raw documentation is written in the [wiki](https://wiki.eclipse.org/EGit/User_Guide).
  43 - __org.eclipse.egit-feature__: Eclipse feature for installing the core
  44     implementation bundles
  45 - __org.eclipse.egit.gitflow-feature__: Eclipse feature for installing the
  46     optional gitflow bundle.
  47 - __org.eclipse.egit.repository__: Definitions for the EGit p2 repository
  48     which can be used to install and upgrade EGit, includes all the features
  49     and plugins from the JGit p2 repository.
  50 - __org.eclipse.egit.source-feature__: Eclipse feature for installing EGit
  51     source bundles to help debugging EGit in Eclipse.
  52
  53 ## Compatibility
  54
  55 - In general, EGit supports at least the latest two Eclipse releases.
  56   For details, please see https://wiki.eclipse.org/EGit/FAQ
  57 - JGit and EGit releases are versioned according to
  58   [OSGi semantic versioning](https://www.osgi.org/wp-content/uploads/SemanticVersioning.pdf)
  59 - Newer version of EGit may implement new functionality, remove
  60   existing functions and change others without other notice than what
  61   is written in the release notes, commit log and source files themselves.
  62
  63 ## Features
  64
  65 The following list is not complete, but it gives an overview of the
  66 features:
  67
  68 - __org.eclipse.egit.core__
  69   - Supplies an Eclipse team provider.
  70   - Connect/disconnect the provider to a project.
  71   - Search for the repositories associated with a project by
  72     autodetecting the Git repository directories.
  73   - Store which repositories are tied to which containers in the
  74     Eclipse workspace.
  75   - Tracks moves/renames/deletes and reflects them in the cache
  76     tree.
  77   - Resolves through linked containers.
  78
  79 - __org.eclipse.egit.ui__
  80   - Connect team provider wizard panels.
  81   - Connect to Git team provider by making a new repository.
  82   - Connect to Git team provider by searching local filesystem
  83     for existing repository directories.
  84   - Team actions: track (add), untrack (remove), disconnect, show
  85     history, compare version.
  86   - Resource decorator shows file/directory state in the package
  87     explorer and other views.
  88   - Creating new commits or amending commits.
  89   - View for staging changes (whole files and partial staging),
  90     showing their differences and committing them.
  91   - Graphical history viewer with the ability to compare versions
  92     using eclipse built-in compare editor.
  93   - Clone, push, pull, fetch
  94   - Merge, rebase, cherry-pick
  95
  96 ## Missing Features
  97
  98 - signing support is incomplete
  99   - verifying signed objects
 100   - signing tags
 101   - signing pushes
 102
 103 ## Support
 104
 105 Post questions or comments to the egit-dev@eclipse.org mailing list.
 106 You need to be [subscribed](https://dev.eclipse.org/mailman/listinfo/egit-dev)
 107 to post.
 108
 109 ## Contributing
 110
 111 See the [EGit Contributor Guide](https://wiki.eclipse.org/EGit/Contributor_Guide).
 112
 113 ## About Git
 114
 115 More information about Git, its repository format, and the canonical
 116 C based implementation can be obtained from the [Git website](https://git-scm.com/).