Jump to: navigation, search

Difference between revisions of "Development Resources/Contributing via Git"

(New page: This page is for individuals who want to make a contribution to an Eclipse project via Git or Gerrit. If you want to contribute to an Eclipse project, you should first communicate with th...)
(No difference)

Revision as of 15:42, 24 June 2013

This page is for individuals who want to make a contribution to an Eclipse project via Git or Gerrit.

If you want to contribute to an Eclipse project, you should first communicate with that project. Communication takes many forms, but generally occurs on a project's "dev" list, or via Bugzilla. You can find the appropriate entry points on the project's web site.

The Commit Record

Minimally, your Git commit record must have the following:

  • A single line summary in the comment field, followed by a more detailed descriptive paragraph;
  • Your credentials (email address) captured in the "Author" field; and
  • A "Signed-off-by" entry with matching credentials in the comment.

If applicable, a reference to the Bug that is addressed by the commit is a helpful addition.

For example:

commit 862e6ff22ad56c10df6de3385ffa4c7d02363d1d
Author: Joe Somebody <somebody@someplace.net>
Date:   Mon Jun 17 17:19:38 2013 -0700

    Auto share multiple projects in single job
    
    When multiple projects are imported together, perform all the necessary
    auto shares in a single job rather than spawning a separate job for each
    project.
    
    Bug: 410937
    Signed-off-by: Joe Somebody <somebody@someplace.net>

The "Signed-off-by" entry is required. By including this, you confirm that you are in compliance with the Certificate of Origin.

Signing off on a commit

Both Git and EGit have built-in support for signing off on a commit.

From command-line Git, add -s to the command:

git commit -s -m "Auto share multiple projects in single job"

From EGit, there is a handy button in the commit dialog box:

Signed-off-by.png

This page is moderated by the EMO.