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/HOWTO/Parallel IP Process"

((2) How It Works)
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<div style="float: right; border: 1px dashed black;
 
background-color: #FFFFDD;"><table><tr><td width="150px">See [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=1166 IPZilla #1166]</td>
 
</tr></table></div><blockquote><em>... Parallel IP approvals for Incubating Projects at Eclipse. This process will clearly benefit Incubating Projects in that they will now be able to proceed with development activity while due diligence is completed in parallel.
 
</em></blockquote>
 
  
 
===(1) Is My Project Eligible (i.e., Conforming)?===
 
===(1) Is My Project Eligible (i.e., Conforming)?===
#All '''''conforming''''' Incubation phase Eclipse projects are eligible to participate in the Parallel IP process. <br>A ''conforming'' project:
+
As of October 2019, parallel IP applies in all cases and is automatically applied. All Eclipse open source projects are eligible.
#* Is in the [http://www.eclipse.org/projects/dev_process/development_process.php#6_2_3_Incubation Incubation phase].
+
#* Correctly displays the [http://www.eclipse.org/projects/dev_process/incubation-conforming.php incubation logo] on their project home page.
+
#* Correctly displays the same incubation logo on their project's primary download page.
+
#* All downloadable zip files for builds (including release builds) and milestones must include the word "incubation" in the filename. For example, <code>DSF-SDK-incubation-N20070413-0200.zip</code>
+
#** The jar files in the download zip file are not required to contain the word "incubation" in the filename. (See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=178944 bug 178944] for the explanation.)
+
#* All "Bundle-Name"s must include the word "incubation". Note that "Bundle-SymbolicName"s should not include "incubation" because the Bundle-SymbolicName is a technical namespace, not a user namespace. For example, <code>Bundle-Name: Foo Plug-in (Incubation)</code>
+
#* Similarly, the names for update manager features must include the word "incubation". For example, <code>Eclipse Platform (Incubation)</code>
+
#*Projects are listed as conforming or non-conforming on the [http://www.eclipse.org/projects/ main /projects page] by the egg (conforming) and egg-with-red-slash (non-conforming) icons. If you believe your project is conforming (i.e., 1-5 above) but is listed on the [http://www.eclipse.org/projects/ main projects page] as non-conforming, send email to the EMO and ask us to update the database.
+
#'''''Mature''''' projects may use parallel ip if the contribution represents a minor change to a previously approved packaged.
+
  
 
===(2) How It Works===
 
===(2) How It Works===
If your project is "incubating (conforming)", then:
+
# Submit a fully formed Contribution Questionnaire (CQ) via [https://dev.eclipse.org/site_login/ the PMI] or [https://dev.eclipse.org/portal/myfoundation/portal/portal.php Portal] for your code or the third-party code that you want to use. A fully formed CQ:
# Submit a fully formed [https://dev.eclipse.org/committers/committertools/cq_part1.php Contribution Questionnaire] (CQ) for your code or the third-party code that you want to use. A fully formed CQ:
+
 
#* Explains where this code or third-party library came from. For example, if this code was developed by the author with the express intent of contributing it to the Eclipse project as soon as the project was provisioned, that should be noted. Or, for example, if this code was part of a commercial product and the company is contributing it to the Eclipse Project, that should be noted (along with documentation proving that the contribution is approved). Etc.
 
#* Explains where this code or third-party library came from. For example, if this code was developed by the author with the express intent of contributing it to the Eclipse project as soon as the project was provisioned, that should be noted. Or, for example, if this code was part of a commercial product and the company is contributing it to the Eclipse Project, that should be noted (along with documentation proving that the contribution is approved). Etc.
#* Includes all nested jar files - a separate IPBug with attached source code must be completed for each nested jar file
+
#* Includes all nested jar files - a separate CQ with attached source code must be completed for each nested jar file
 
#* Identifies all applicable licenses
 
#* Identifies all applicable licenses
 
#* Includes references (ipzilla urls) to all existing IPZilla entries for the same jar files (same name and exact version) -or-
 
#* Includes references (ipzilla urls) to all existing IPZilla entries for the same jar files (same name and exact version) -or-
Line 27: Line 13:
 
#* The normal IP due diligence process requires that the legal review be completed before the code is checked into the source code repository. [[Image:Normal-ip-flow.gif]]
 
#* The normal IP due diligence process requires that the legal review be completed before the code is checked into the source code repository. [[Image:Normal-ip-flow.gif]]
 
#* The parallel IP process allows the check-in to occur before the legal review is complete (but after the preliminary legal approval) - the legal review must be completed before the code is included in a release. [[Image:Parallel-ip-flow.gif]]
 
#* The parallel IP process allows the check-in to occur before the legal review is complete (but after the preliminary legal approval) - the legal review must be completed before the code is included in a release. [[Image:Parallel-ip-flow.gif]]
# Eclipse Legal will review the IPZilla. If it is fully formed and the licenses are compatible with the EPL, Eclipse Legal will mark the IPZilla with the <code>checkintocvs</code> keyword.
+
# Eclipse Legal will review the IPZilla. If it is fully formed and the licenses are compatible with the EPL, Eclipse Legal will mark the IPZilla with the <code>checkin</code> keyword.
# Once the <code>checkintocvs</code> keyword appears on the IPZilla (IPZilla, of course, will notify you by email when there are changes to your "IP bug"), you may then check the related code into CVS/SVN.
+
# Once the <code>checkin</code> keyword appears on the IPZilla (IPZilla, of course, will notify you by email when there are changes to your "IP bug"), you may then check the related code into the Eclipse repository assigned to your project.
 
# Eclipse Legal will continue their due diligence review in parallel.
 
# Eclipse Legal will continue their due diligence review in parallel.
 
# '''Important:''' if, after a period of time, the code related to this IP bug is no longer needed, please let the Eclipse Legal team know so that the Foundation can focus its limited resources on other due diligence requests.
 
# '''Important:''' if, after a period of time, the code related to this IP bug is no longer needed, please let the Eclipse Legal team know so that the Foundation can focus its limited resources on other due diligence requests.
Line 36: Line 22:
 
* [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=1166 IPZilla #1666 "Rolling out Parallel IP Approvals for Incubating Projects"]
 
* [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=1166 IPZilla #1666 "Rolling out Parallel IP Approvals for Incubating Projects"]
 
* [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf Due Diligence Process workflow (poster)]
 
* [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf Due Diligence Process workflow (poster)]
* [http://milinkovich.blogspot.com/2007/01/parallel-ip-approvals-for-incubating.html Announcement on Mike's blog]
+
* [http://mmilinkov.wordpress.com/2007/01/22/parallel-ip-approvals-for-incubating-projects/ Announcement on Mike's blog]
  
 
''This page is moderated by the EMO''
 
''This page is moderated by the EMO''
 
[[Category:Development_Resources]]
 
[[Category:Development_Resources]]
 
[[Category:How to Contribute]]
 
[[Category:How to Contribute]]

Revision as of 22:29, 17 June 2020

(1) Is My Project Eligible (i.e., Conforming)?

As of October 2019, parallel IP applies in all cases and is automatically applied. All Eclipse open source projects are eligible.

(2) How It Works

  1. Submit a fully formed Contribution Questionnaire (CQ) via the PMI or Portal for your code or the third-party code that you want to use. A fully formed CQ:
    • Explains where this code or third-party library came from. For example, if this code was developed by the author with the express intent of contributing it to the Eclipse project as soon as the project was provisioned, that should be noted. Or, for example, if this code was part of a commercial product and the company is contributing it to the Eclipse Project, that should be noted (along with documentation proving that the contribution is approved). Etc.
    • Includes all nested jar files - a separate CQ with attached source code must be completed for each nested jar file
    • Identifies all applicable licenses
    • Includes references (ipzilla urls) to all existing IPZilla entries for the same jar files (same name and exact version) -or-
    • Attaches related source code for the jar files if there is no existing IPZilla for those jar files (same name and exact version) yet.
  2. Add a comment to the CQ (or its resulting IPZilla) that you are requesting the Parallel IP process for this contribution. Note that the Parallel IP process does not eliminate the requirement on either yourself or on the Foundation to complete the due diligence review of the contribution - it merely rearranges the deadlines and check points.
    • The normal IP due diligence process requires that the legal review be completed before the code is checked into the source code repository. Normal-ip-flow.gif
    • The parallel IP process allows the check-in to occur before the legal review is complete (but after the preliminary legal approval) - the legal review must be completed before the code is included in a release. Parallel-ip-flow.gif
  3. Eclipse Legal will review the IPZilla. If it is fully formed and the licenses are compatible with the EPL, Eclipse Legal will mark the IPZilla with the checkin keyword.
  4. Once the checkin keyword appears on the IPZilla (IPZilla, of course, will notify you by email when there are changes to your "IP bug"), you may then check the related code into the Eclipse repository assigned to your project.
  5. Eclipse Legal will continue their due diligence review in parallel.
  6. Important: if, after a period of time, the code related to this IP bug is no longer needed, please let the Eclipse Legal team know so that the Foundation can focus its limited resources on other due diligence requests.

(3) Explanations and Documents

This page is moderated by the EMO

Back to the top