Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Development Resources/Committer Cheat Sheet"

(Created page with "=Getting Help= * For IT assistance--including help with account access--contact the [mailto:webmaster@eclipse.org webmaster@eclipse.org] or open a bug (see below). * For ques...")
 
Line 28: Line 28:
 
* Use your committer id and password to authenticate via SSH with Git or Gerrit; and
 
* Use your committer id and password to authenticate via SSH with Git or Gerrit; and
 
* When accessing Gerrit via HTTPS, use your committer id in combination with the password generated by Gerrit.
 
* When accessing Gerrit via HTTPS, use your committer id in combination with the password generated by Gerrit.
 +
 +
=Commits=
 +
 +
Individual projects set their own standards, so be sure to check with your team and project lead for further guidance. Minimally, though, Git commits should have the following:
 +
 +
* Your proper name and email address associated with your Eclipse Foundation Account in the author credentials;
 +
* The id of the associated bug in square brackets;
 +
* A well-written summary line; and
 +
* A useful but concise comment body.
 +
 +
For example:
 +
<pre>commit 862e6ff22ad56c10df6de3385ffa4c7d02363d1d
 +
Author: Joe Somebody <somebody@someplace.net>
 +
Date:  Mon Jun 17 17:19:38 2015 -0700
 +
 +
    [410937] 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.</pre>
 +
 +
A committer can push commits on behalf of other committers. The email address in the "author" field must match the email address associated with the committer's Eclipse Foundation account.
 +
 +
Contributions from non-committers must additionally have a "Signed-off-by" line in the footer. For example:
 +
<pre>commit 862e6ff22ad56c10df6de3385ffa4c7d02363d1d
 +
Author: Joe Somebody <somebody@someplace.net>
 +
Date:  Mon Jun 17 17:19:38 2013 -0700
 +
 +
    [410937] 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.
 +
   
 +
    Also-by: Some Otherperson <otherperson@someplace.net>
 +
    Signed-off-by: Joe Somebody <somebody@someplace.net></pre>
 +
Any push attempt to either Git or Gerrit will be accepted only if the contributor has signed a Contributor License Agreement (CLA) and the commit has been "signed off". The email address in the author credentials and signed-off-by field must match.
 +
 +
Note that you can specify multiple authors for a single commit by including "Also-by" entries.

Revision as of 06:21, 26 March 2015

Getting Help

  • For IT assistance--including help with account access--contact the webmaster@eclipse.org or open a bug (see below).
  • For questions concerning the intellectual property due-diligence process, contact emo-ip-team@eclipse.org.
  • For questions regarding the Eclipse Development Process, or anything else regarding open source project management, contact emo@eclipse.org.

The Webmaster team uses Bugzilla to track requests. You can create the request directly yourself, or the Webmaster may do it on your behalf. In general, these requests are found under the Community bugzilla product, but if it makes more sense, you can open a bug under your project's Bugzilla product with the webmaster@eclipse.org in copy.

Open a bug to request help with:

Identity

We maintain your identity with your Eclipse Foundation Account. Visit My Account (a link to "Edit my account" is on the top of most of our web pages). Use this page to:

  • Edit your personal information (email address, postal address, other contact information);
  • Access your project's Hudson instance;
  • Other committer tools.

Every account has a "committer id" (this is typically your first initial and your last name, e.g. "wbeaton"), a primary email address, and passord.

Use your email address to log into most of Eclipse Foundation services, with these exceptions:

  • Use your committer id and password to authenticate via SSH with Git or Gerrit; and
  • When accessing Gerrit via HTTPS, use your committer id in combination with the password generated by Gerrit.

Commits

Individual projects set their own standards, so be sure to check with your team and project lead for further guidance. Minimally, though, Git commits should have the following:

  • Your proper name and email address associated with your Eclipse Foundation Account in the author credentials;
  • The id of the associated bug in square brackets;
  • A well-written summary line; and
  • A useful but concise comment body.

For example:

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

    [410937] 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.

A committer can push commits on behalf of other committers. The email address in the "author" field must match the email address associated with the committer's Eclipse Foundation account.

Contributions from non-committers must additionally have a "Signed-off-by" line in the footer. For example:

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

    [410937] 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.
    
    Also-by: Some Otherperson <otherperson@someplace.net>
    Signed-off-by: Joe Somebody <somebody@someplace.net>

Any push attempt to either Git or Gerrit will be accepted only if the contributor has signed a Contributor License Agreement (CLA) and the commit has been "signed off". The email address in the author credentials and signed-off-by field must match.

Note that you can specify multiple authors for a single commit by including "Also-by" entries.

Back to the top