Jump to: navigation, search

Difference between revisions of "Development Resources/Initial Contribution"

Line 11: Line 11:
 
#*All bundles and package names must conform to the established conventions, and
 
#*All bundles and package names must conform to the established conventions, and
 
#*Be sure to rename extension-point ids and bundle Ids embedded in your code;
 
#*Be sure to rename extension-point ids and bundle Ids embedded in your code;
#Ensure that [http://www.eclipse.org/legal/copyrightandlicensenotice.php Eclipse copyright and license notice(s)] in the required form have been applied to source content including configuration files when possible (Note that the Eclipse project's [[Platform-releng-faq#How do I use the releng plugin?|Releng Tools]] can help you with copyright notices);
+
#Ensure that [http://www.eclipse.org/legal/copyrightandlicensenotice.php Eclipse copyright and license notice(s)] in the required form have been applied to source content including configuration files when possible (Note that the Eclipse project's [[Development Resources/How to Use the Eclipse Copyright Tool|Copyright Tool]] can help you with copyright notices);
 
#Make sure that you have the required [http://www.eclipse.org/legal/guidetolegaldoc.php notices]:  
 
#Make sure that you have the required [http://www.eclipse.org/legal/guidetolegaldoc.php notices]:  
 
#*[[The about.html|about.html]], license files etc.;
 
#*[[The about.html|about.html]], license files etc.;

Revision as of 13:05, 30 September 2011

Before you can make an initial contribution, your project needs to be provisioned. As part of that process, your project will be given a code repository, access to the downloads server, etc. You and your other developers will also be given committer access; only committers can write code into your code repository. But before you start writing to the repository, your first contribution ("initial contribution") must be scrutinized by the Eclipse IP Team.

Before you begin, make sure that you are familiar with your top-level project's charter, and that the contribution aligns with the scope of that charter and the scope defined by your project. You should discuss the nature of the contribution with your project, parent project leadership (if any), and PMC. Your PMC will be required to authorize your contribution; socialization of the contribution will make the process run more smoothly.

Please make sure that you are familiar with the Eclipse Due Diligence Process. If you have any questions, please ask your PMC or project mentors.

To make your initial contribution:

  1. Wait until you receive notice from the Webmaster that your project has been provisioned;
  2. Ensure that the namespace in your contribution aligns with Eclipse naming conventions (i.e. org.eclipse.<project-name>.*)
    • All bundles and package names must conform to the established conventions, and
    • Be sure to rename extension-point ids and bundle Ids embedded in your code;
  3. Ensure that Eclipse copyright and license notice(s) in the required form have been applied to source content including configuration files when possible (Note that the Eclipse project's Copyright Tool can help you with copyright notices);
  4. Make sure that you have the required notices:
  5. Pack up the source code and attach it to a Bugzilla record as "Initial Contribution" under your new project's Bugzilla component
    • Ensure that there are no nested JARs or ZIP files in the content;
  6. Then use the Foundation Portal to open a "Contribution Questionnaire" (CQ) referencing this Bug; and
  7. When you receive the email requesting you to do so, attach the same file to the CQ itself (the attachment must be made on both the Bugzilla bug and the IPZilla CQ).

Note that no nested jar files or zip files should be included in CQ attachment. Project-licensed content and third-party-licensed content are not reviewed together. Separate CQs are required. Please familiarize yourself with the Eclipse Policy and Procedures for Third Party Dependencies. Again, if you are uncertain, please ask your PMC or project mentors for assistance.

More information is available in The New Committer Handbook.