Jump to: navigation, search

Development Resources/Processes

Disclaimer: These are the templated responses we use for email/bugs. This is a work in progress.

Project Creation

Proposal

Creation Review

Not Scheduled Yet

Next Steps Project Can Do (Work on initial contribution)

Hi Folks,

Your projects creation review has not yet been scheduled.

You can start thinking about and working on getting your initial code
contribution put together. This will help speed up the project on-boarding process.


Next Steps for the Project
==========================

We will schedule the creation review once we have acquired the Trademark, 2 project mentors and
two weeks of community review have passed.


Interim Work The Project Can Do Before Creation Review
======================================================
Couple of items that you can get going on:

* Please have your project leads and committers create Eclipse accounts [1], then log into [2].
This will help speed up the provisioning teams workflow to get all the projects
resources in place quickly.
** Please note, that the email addresses for committers in the proposal must match the email 
addresses associated with the Eclipse account.

* Legal Paperwork for Committers
** Please review [3] which discusses the committer paperwork required. Start this process as soon as possible, it may take time to complete. 
*** Before the project can be fully provisioned by the Webmaster team, the project needs to have at least one committer with all the required paperwork provided.

* The new project [4] can begin to assemble the projects initial code
contribution [5].

Before you can make an initial contribution, your project needs to be
provisioned. Getting the code ready now will reduce the time to submit the initial
contribution once we've provisioned the project.


Initial Code Contribution
-------------------------

Broadly speaking, the initial code contribution involves:
(this is a quick summary of [5])

- If applicable, update the package namespace. For example
for Java based projects  [6].

- Review "A Guide to the Legal Documentation for Eclipse-Based Content" [7]

- Ensuring Eclipse copyright, license [8] and "about" notices [9].

- Identify all third-party party libraries.


Other items to be aware of with the initial code contribution:

- Code cannot be pushed to the project's source code repository until after
the IP team has approved the initial Contribution.

- The initial contribution must be the first commit in your
project repository. History must be collapsed into that single commit [10].

- Any third-party libraries required by your code will have to be checked and
approved by the IP Team.

- Project-licensed content and third-party-licensed content are not
reviewed together. Separate Contribution Questionnaires (CQ's) [11] are required.


Important: Legal
================

Please familiarize yourself with the IP Due Diligence Process [12] and the
Parallel IP Process [13]. As an incubating project you can take advantage of
Parallel IP to get moving quicker with development.


Project Resources
=================

Please have a look at the Development Resources wiki [14] and [15] the EDP process.



Your project mentors are an excellent resource if you need guidance.
We urge you to make use of their expertise.


Cheers,

Richard


[1] https://dev.eclipse.org/site_login/createaccount.php
[2] https://dev.eclipse.org/site_login/
[3] https://wiki.eclipse.org/Development_Resources/HOWTO/Nominating_and_Electing_a_New_Committer#What_Paperwork_Does_the_New_Committer_Need_.28and_Why.29.3F
[4] https://wiki.eclipse.org/Development_Resources/HOWTO/Starting_A_New_Project
[5] http://wiki.eclipse.org/Development_Resources/Initial_Contribution
[6] https://wiki.eclipse.org/Development_Resources/HOWTO/The_Eclipse_Code_Namespace_Policy
[7] https://www.eclipse.org/legal/guidetolegaldoc.php
[8] https://www.eclipse.org/legal/copyrightandlicensenotice.php
[9] https://www.eclipse.org/legal/epl/about.php
[10] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub#Collapsing_History
[11] https://wiki.eclipse.org/Development_Resources/Contribution_Questionnaire
[12] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
[13] http://www.eclipse.org/projects/dev_process/parallel-ip-process.php
[14] https://wiki.eclipse.org/Development_Resources
[15] https://www.eclipse.org/projects/dev_process/development_process.php

Scheduled

Steps Project Can Do (Work on initial contribution and provide us information for provisioning)

Hi Folks,

Your projects creation review has been scheduled.


Next Steps for the Project
==========================

We will take care of provisioning for you once the project creation review is declared successful.

Make sure that your committers know that they will receive instructions 
regarding required paperwork after the creation review is declared successful.


Information We Need
-------------------

- Please confirm the details of the project proposal section "Source Code".


Interim Work The Project Can Do Before Creation Review
======================================================
Couple of items that you can get going on:

- Please have your project leads and committers create Eclipse accounts [1], then log into [2].
This will help speed up the provisioning teams workflow to get all the projects
resources in place quickly.

- Please note, that the email addresses for committers in the proposal must match the email 
addresses associated with the Eclipse account.

- The new project [3] can begin to assemble the projects initial code
contribution [4].

Before you can make an initial contribution, your project needs to be
provisioned. Getting the code ready now will reduce the time to submit the initial
contribution once we've provisioned the project.


Initial Code Contribution
-------------------------

Broadly speaking, the initial code contribution involves:
(this is a quick summary of [4])

- If applicable, update the package namespace. For example
for Java based projects  [5].

- Review "A Guide to the Legal Documentation for Eclipse-Based Content" [6]

- Ensuring Eclipse copyright, license [7] and "about" notices [8].

- Identify all third-party party libraries.


Other items to be aware of with the initial code contribution:

- Code cannot be pushed to the project's source code repository until after
the IP team has approved the initial Contribution.

- The initial contribution must be the first commit in your
project repository. History must be collapsed into that single commit [9].

- Any third-party libraries required by your code will have to be checked and
approved by the IP Team.

- Project-licensed content and third-party-licensed content are not
reviewed together. Separate Contribution Questionnaires (CQ's) [10] are required.


Important: Legal
================

Please familiarize yourself with the IP Due Diligence Process [11] and the
Parallel IP Process [12]. As an incubating project you can take advantage of
Parallel IP to get moving quicker with development.


Project Resources
=================

Please have a look at the Development Resources wiki [13] and [14] the EDP process.



Your project mentors are an excellent resource if you need guidance.
We urge you to make use of their expertise.


Cheers,

Richard


[1] https://dev.eclipse.org/site_login/createaccount.php
[2] https://dev.eclipse.org/site_login/
[3] https://wiki.eclipse.org/Development_Resources/HOWTO/Starting_A_New_Project
[4] http://wiki.eclipse.org/Development_Resources/Initial_Contribution
[5] https://wiki.eclipse.org/Development_Resources/HOWTO/The_Eclipse_Code_Namespace_Policy
[6] https://www.eclipse.org/legal/guidetolegaldoc.php
[7] https://www.eclipse.org/legal/copyrightandlicensenotice.php
[8] https://www.eclipse.org/legal/epl/about.php
[9] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub#Collapsing_History
[10] https://wiki.eclipse.org/Development_Resources/Contribution_Questionnaire
[11] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
[12] http://www.eclipse.org/projects/dev_process/parallel-ip-process.php
[13] https://wiki.eclipse.org/Development_Resources
[14] https://www.eclipse.org/projects/dev_process/development_process.php



Provisioning

Requested - Next Steps Project Can Do (Work on initial contribution)

Hi Folks,

We have initiated the provisioning process for your project. 

Please watch your email for information and further instructions. 
This is a multi-step process that requires input from the project 
committers before we can do much else. 

Please complete the committer questionnaire and provide the requested
committer documentation as soon as possible so that we can push forward.


FYI
===

Let your new committers know that they won't be able to fill in their
committer questionnaires until they have received their automated email 
titled "New Committer Request Form."

A "project information" page [1] has been created that you can use to share
information about the project with the community. As your committers are
provisioned, they will be able to edit the information on this page.


Next Steps for the Project
==========================

The next step for the project will be the initial code contribution. While 
you're waiting for provisioning, you can start working on 
the initial contribution.


Initial Code Contribution
-------------------------

Broadly speaking, the initial code contribution involves:
(this is a quick summary of [2])

- If applicable, update the package namespace. For example
for Java based projects  [3].

- Review "A Guide to the Legal Documentation for Eclipse-Based Content" [4]

- Ensuring Eclipse copyright, license [5] and "about" notices [6].

- Identify all third-party party libraries.


Other items to be aware of with the initial code contribution:

- Code cannot be pushed to the project's source code repository until after
the IP team has approved the initial Contribution.

- The initial contribution must be the first commit in your
project repository. History must be collapsed into that single commit [7].

- Any third-party libraries required by your code will have to be checked and
approved by the IP Team.

- Project-licensed content and third-party-licensed content are not
reviewed together. Separate Contribution Questionnaires (CQ's) [8] are required.


Important: Legal
================

Please familiarize yourself with the IP Due Diligence Process [9] and the
Parallel IP Process [10]. As an incubating project you can take advantage of
Parallel IP to get moving quicker with development.


Project Resources
=================

Please have a look at the Development Resources wiki [11] and [12] the EDP process.



Your project mentors are an excellent resource if you need guidance.
We urge you to make use of their expertise.


Cheers,

Richard


[1] /////////// add project pmi page
[2] http://wiki.eclipse.org/Development_Resources/Initial_Contribution
[3] https://wiki.eclipse.org/Development_Resources/HOWTO/The_Eclipse_Code_Namespace_Policy
[4] https://www.eclipse.org/legal/guidetolegaldoc.php

[5] https://www.eclipse.org/legal/copyrightandlicensenotice.php
[6] https://www.eclipse.org/legal/epl/about.php
[7] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub#Collapsing_History
[8] https://wiki.eclipse.org/Development_Resources/Contribution_Questionnaire
[9] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
[10] http://www.eclipse.org/projects/dev_process/parallel-ip-process.php
[11] https://wiki.eclipse.org/Development_Resources
[12] https://www.eclipse.org/projects/dev_process/development_process.php

Finished -- Raise CQ's

Once provisioning is completed the project can now raise CQ's (there is at least one committer assigned to the project)

CQ's to be raised:

  • initial code contribution
  • all third party libraries
Hi Folks,

Besides raising [1] a Contribution Questionnaire (CQ's) for the projects initial code contribution, you 
must also raise CQ's for every third-party library [2] that your project code makes direct use of.  We 
recommend that you only file a few third party CQ's initially and work with the IP Team through the process. 
This will help ease any learning curve and ensure that no unnecessary work is undertaken.

Please check Orbit (repository of bundled versions containing third party libraries that are approved for use in one or 
more Eclipse projects) [3][4] to see if a library you require is available.

Please review our guidelines for 3rd Party Dependencies [5]. Please first discuss with your Mentors 
and/or PMC if you have any questions.


Thanks and let us know if you have any questions either via the bug or emailing us via the EMO at <emo@eclipse.org>.

Richard


[1] https://wiki.eclipse.org/Project_Management_Infrastructure/Creating_A_Contribution_Questionnaire
[2] https://wiki.eclipse.org/Development_Resources/Contribution_Questionnaire#Third_Party_Libraries
[3] https://www.eclipse.org/orbit/
[4] http://download.eclipse.org/tools/orbit/downloads/
[5] https://www.eclipse.org/org/documents/Eclipse_Policy_and_Procedure_for_3rd_Party_Dependencies_Final.pdf


Initial Contribution

Submitting IC

Hi Folks,

The project has now been provisioned.


Next Steps for the Project
==========================

The next step for the project will be the initial code contribution.

We use a modified version of Bugzilla that we call IPZilla [1] [2] 
intellectual property contributions for projects. This is only accessible to committers.

Individual contribution records are called Contribution Questionnaire (CQ's) [3] . A CQ 
is required for the projects initial contribution and all third party libraries. 


Broadly speaking, the initial code contribution involves:
(this is a quick summary of [4])

- If applicable, update the package namespace. For example
for Java based projects  [5].

- Review "A Guide to the Legal Documentation for Eclipse-Based Content" [6]

- Ensuring Eclipse copyright, license [7] and "about" notices [8].

- Identify all third-party party libraries.


Other items to be aware of with the initial code contribution:

- Code cannot be pushed to the project's source code repository until after
the IP team has approved the initial Contribution.

- The initial contribution must be the first commit in your
project repository. History must be collapsed into that single commit [9].

- Any third-party libraries required by your code will have to be checked and
approved by the IP Team.

- Project-licensed content and third-party-licensed content are not
reviewed together. Separate Contribution Questionnaires (CQ's) [3] are required.

Important: Legal
================

Please familiarize yourself with the IP Due Diligence Process [10] and the
Parallel IP Process [11]. As an incubating project you can take advantage of
Parallel IP to get moving quicker with development.


Project Resources
=================

Please have a look at the Development Resources wiki [12] and [13] the EDP process.



Your project mentors are an excellent resource if you need guidance. We urge 
you to make use of their expertise.


Thanks and let me know if you have any questions,

Richard


[1] https://wiki.eclipse.org/IPzilla
[2] https://dev.eclipse.org/ipzilla/
[3] https://wiki.eclipse.org/Development_Resources/Contribution_Questionnaire
[4] http://wiki.eclipse.org/Development_Resources/Initial_Contribution
[5] https://wiki.eclipse.org/Development_Resources/HOWTO/The_Eclipse_Code_Namespace_Policy
[6] https://www.eclipse.org/legal/guidetolegaldoc.php
[7] https://www.eclipse.org/legal/copyrightandlicensenotice.php
[8] https://www.eclipse.org/legal/epl/about.php
[9] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub#Collapsing_History
[10] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
[11] http://www.eclipse.org/projects/dev_process/parallel-ip-process.php
[12] https://wiki.eclipse.org/Development_Resources
[13] https://www.eclipse.org/projects/dev_process/development_process.php

Development After Submitting IC

You can continue to develop while the IP team reviews the initial contribution.
Anything that you commit after the initial contribution must be done so under
the terms of the IP Due Diligence process (e.g. committers can just keep
working).

Make your initial contribution be the first commit in your new repository (Git or GitHub).

If you have an existing repository (GitHub) that you'd like to move, connect
with the webmaster for help.

Let us know if you need assistance.

Parallel IP

Approved

Hi Folks,

Your project has received Parallel-IP check-in approval from the IP Team for
the initial code contribution.


Next Steps for the Project
==========================

Commit the projects approved initial contribution into the projects repository. 
Please note that history must be collapsed into that single commit.

If you have any questions pertaining to the repository or collapsing the history, 
please contact the Webmaster <webmaster@eclipse.org>.


Important: Legal
================

The Parallel IP process allows the check-in to occur before the full legal review
is complete (but after preliminary legal approval). The full legal review must
be completed before the code is included in a release.

Please review "A Guide to the Legal Documentation for Eclipse-Based Content" [1].
This is an ongoing process for the project.


Accepting Code
==============

The IP Due Diligence Process [2] is an on going process and needs to be followed
closely.


Contributors
------------

Please review [3] on how to handle code submissions.


Committers
----------

FYI [4].


For Projects Hosted on GitHub
-------------------------

Please review hosting a project on GitHub [5] and social coding FAQ's [6].


Project Resources
=================

Please have a look at the Development Resources wiki [7], [8] the EDP process
and Contribution License Agreement (CLA) [9].



Your project mentors are an excellent resource if you need guidance. We urge 
you to make use of their expertise.


Cheers,

Richard


[1] https://www.eclipse.org/legal/guidetolegaldoc.php
[2] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
[3] https://wiki.eclipse.org/Development_Resources/Contributing_via_Git
[4] https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions
[5] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub
[6] https://www.eclipse.org/org/SocialCodingFAQ.php
[7] https://wiki.eclipse.org/Development_Resources
[8] https://www.eclipse.org/projects/dev_process/development_process.php
[9] https://wiki.eclipse.org/CLA

Initial Contribution Approved

Add content

Release Review

Guidance


 - Please review the "A Guide to the Legal Documentation for Eclipse-Based Content" [1]. Please
do so before generating the IP Log for review. Issues or omissions with required notices will
delay the review process.


[1] https://www.eclipse.org/legal/guidetolegaldoc.php


Termination Review

Add content

GitHub

Additional steps for committers

Once your committer account is created, you'll need to add your GitHub id to your committer account before you can commit.  
Login here: https://dev.eclipse.org/site_login and under the 'account details' fold enter your GitHub name 
in the box labelled 'GitHub id'.  

Once we have that you should automatically be added to your projects GitHub team shortly.

Dual Licensing

Requesting

The //name// project wants to be dual licensed EPL+ //other license//.

//project proposal url//

Dual licensing of an Eclipse project requires approval from the Board of Directors. 

To get approval, we need to make a short presentation [1] (3-4 slides) to the Board that discusses the following:
- why the project needs to be dual licensed. 
- what licenses are you requesting.

Attach the presentation to the bug used to track the dual license request [2].

I would suggest adding a final slide that makes it clear what is the decision being asked of the Board.


Cheers,

Richard


[1] https://wiki.eclipse.org/Development_Resources/HOWTO/Starting_A_New_Project#Licensing
[2] /////// bug url to track dual license request ///////

Granted

The projects dual licensing request has been approved by the Board [1].

The project now needs to update the following files in it's code repository:
- code copyright headers
- about.html
- copyright and license file
- any other notices that are required

Please see [2] for Eclipse Legal resources, in particular [3], [4].


Cheers,

Richard


[1] ////// update with licensing bug ////////
[2] https://www.eclipse.org/legal/
[3] https://www.eclipse.org/legal/epl/about.php
[4] https://www.eclipse.org/legal/copyrightandlicensenotice.php


Accounts

Eclipse Accounts for Proposals

Hi Folks,

Please have your project leads and committers create Eclipse accounts [1], then log into [2]. Please also log into [3]. This will create the identities on our Bugzilla bug tracker so you can
be added as /cc to bugs etc.

Please note, that the email addresses for committers in the proposal must match the email addresses associated with the Eclipse account.


Cheers,

Richard


[1] https://dev.eclipse.org/site_login/createaccount.php
[2] https://dev.eclipse.org/site_login
[3] https://bugs.eclipse.org/bugs/

Moving Project Code

Code From An Existing Project into a New Project

 Please provide a list of CQs that can be moved from //old project// to //new project//. A CQ can be
moved if it is only required by the //new project// code and is no longer required by the
//old project// project.

For CQs that are required by //new project//, but need to stay with //old project//, please open
piggyback CQs. Let us know if you require further explanation or assistance.