Jump to: navigation, search

Difference between revisions of "Development Resources/HOWTO/Starting A New Project"

Line 1: Line 1:
Before you propose a new project at Eclipse, make sure that you understand the value proposition. Eclipse is more than just a place for hosting code; Eclipse is very much about community, adoption, and eco-system. Projects are expected to take necessary precautions to mitigate the risk to adopters; a company that integrates the code from your Eclipse project, for example, does so with confidence that the code in your project can legally be distributed under the agreed-to terms. The processes that we have in place are designed to support this.
+
Code is very important at Eclipse. All Eclipse projects are expected to have code. But the responsibilities of an Eclipse project extend far beyond having code in an eclipse.org repository. Eclipse projects are responsible for developing a community of users, adopters, and contributors.
  
Ensure that you are familiar with the [http://www.eclipse.org/dev_process/development_process.php Eclipse Development Process] (EDP), [http://eclipse.org/org/documents/Eclipse_IP_Policy.pdf Eclipse IP Policy], and [http://eclipse.org/legal/EclipseLegalProcessPoster.pdf IP Due Diligence Process].  
+
Before you bring your project over to Eclipse, you must have useful code and the beginnings of a community. [http://www.eclipselabs.org Eclipse Labs] provides a great place to host your project during this formative period. In fact, depending on the nature of your project, Eclipse Labs may be the right place to host your projects in perpetuity. If it is your intent to one day move the project to Eclipse, you should take the time to familiarize yourself with our processes to avoid surprises downstream (e.g. you should consider carefully tracking all contributions to the project).
 +
 
 +
Eclipse projects are expected to take necessary precautions to mitigate the risk to adopters; a company that integrates the code from your Eclipse project, for example, does so with confidence that the code in your project can legally be distributed under the agreed-to terms. The processes that we have in place are designed to support this. Ensure that you are familiar with the [http://www.eclipse.org/dev_process/development_process.php Eclipse Development Process] (EDP), [http://eclipse.org/org/documents/Eclipse_IP_Policy.pdf Eclipse IP Policy], and [http://eclipse.org/legal/EclipseLegalProcessPoster.pdf IP Due Diligence Process].  
  
 
The EDP is mostly about community involvement. An Eclipse project is considered successful only if a vibrant community develops around it. While the reviews and processes described by the EDP may seem onerous, they are a necessary part of community development. You should anticipate spending a significant amount of time responding to questions posed in various forums ([http://www.eclipse.org/forums Eclipse Forums], [http://www.eclipse.org/mail/ mailing lists], or even [http://stackoverflow.com/questions/tagged/eclipse Stack Overflow]. You should plan on attending conferences (especially [http://eclipsesummit.org/ Eclipse Summit Europe] and [http://eclipsecon.org EclipseCon]), presenting webinars, writing papers, etc to support your project.
 
The EDP is mostly about community involvement. An Eclipse project is considered successful only if a vibrant community develops around it. While the reviews and processes described by the EDP may seem onerous, they are a necessary part of community development. You should anticipate spending a significant amount of time responding to questions posed in various forums ([http://www.eclipse.org/forums Eclipse Forums], [http://www.eclipse.org/mail/ mailing lists], or even [http://stackoverflow.com/questions/tagged/eclipse Stack Overflow]. You should plan on attending conferences (especially [http://eclipsesummit.org/ Eclipse Summit Europe] and [http://eclipsecon.org EclipseCon]), presenting webinars, writing papers, etc to support your project.
Line 7: Line 9:
 
There is tremendous value in the Eclipse IP Policy, but that value comes at a cost. It is important that you understand what is involved. Code provenance tracking is critical (we need to know the source of all code that ends up in our repositories). To that end, all new projects are required to make an [[Development Resources/Initial Contribution | initial contribution]] before '''any''' code is committed to an Eclipse source code repository (one implication of this requirement is that we assume that a new project starts from pre-existing code). The Eclipse IP Team will review your initial contribution to ensure that the code can distributed through an eclipse.org property. In effect, we review to code to make sure that it hasn't been copied inappropriately, that licenses are being used correctly, and so forth. As part of this process, the IP Team will research the source of all code; depending on the size of your contribution, this can be a time-consuming process. Furthermore, any third-party libraries required by your code will have to be checked and approved by the IP Team. As an Eclipse project you are expected to maintain an [[Development Resources/IP Log | IP Log]] containing (among other things) information about all contributions and third-party libraries; you are required to submit this log for review and approval as part of the release process.
 
There is tremendous value in the Eclipse IP Policy, but that value comes at a cost. It is important that you understand what is involved. Code provenance tracking is critical (we need to know the source of all code that ends up in our repositories). To that end, all new projects are required to make an [[Development Resources/Initial Contribution | initial contribution]] before '''any''' code is committed to an Eclipse source code repository (one implication of this requirement is that we assume that a new project starts from pre-existing code). The Eclipse IP Team will review your initial contribution to ensure that the code can distributed through an eclipse.org property. In effect, we review to code to make sure that it hasn't been copied inappropriately, that licenses are being used correctly, and so forth. As part of this process, the IP Team will research the source of all code; depending on the size of your contribution, this can be a time-consuming process. Furthermore, any third-party libraries required by your code will have to be checked and approved by the IP Team. As an Eclipse project you are expected to maintain an [[Development Resources/IP Log | IP Log]] containing (among other things) information about all contributions and third-party libraries; you are required to submit this log for review and approval as part of the release process.
  
The Eclipse Foundation holds the trademark for all Eclipse projects. Trademark assignment is undertaken prior to the creation of any new project. If you already have a trademark on your project name, that trademark must be assigned to the Eclipse Foundation.
+
The Eclipse Foundation holds the trademark for all Eclipse projects. Trademark assignment is undertaken prior to the creation of any new project. If you already have a trademark on your project name, that trademark must be assigned to the Eclipse Foundation. Be advised that trademark assignment can be a time-consuming process (it can take hours, days, or weeks depending on the circumstances surrounding the name).
  
 
Here are some other links that should help you with the process:
 
Here are some other links that should help you with the process:
Line 18: Line 20:
  
 
This should sound like a lot of work. For many projects, the investment is worthwhile.
 
This should sound like a lot of work. For many projects, the investment is worthwhile.
 
If you are concerned that the requirements and responsibilities of operation of an Eclipse project are too great, you should consider hosting your project at [http://www.eclipselabs.org Eclipse Labs]. Note that, should you hope to one day move the project to Eclipse, you should take the time to familiarize yourself with our processes to avoid surprises downstream (e.g. you should consider carefully tracking all contributions to the project).
 
  
 
[[Category:Development_Resources]]
 
[[Category:Development_Resources]]
 
[[Category:How to Contribute]]
 
[[Category:How to Contribute]]

Revision as of 13:13, 13 December 2010

Code is very important at Eclipse. All Eclipse projects are expected to have code. But the responsibilities of an Eclipse project extend far beyond having code in an eclipse.org repository. Eclipse projects are responsible for developing a community of users, adopters, and contributors.

Before you bring your project over to Eclipse, you must have useful code and the beginnings of a community. Eclipse Labs provides a great place to host your project during this formative period. In fact, depending on the nature of your project, Eclipse Labs may be the right place to host your projects in perpetuity. If it is your intent to one day move the project to Eclipse, you should take the time to familiarize yourself with our processes to avoid surprises downstream (e.g. you should consider carefully tracking all contributions to the project).

Eclipse projects are expected to take necessary precautions to mitigate the risk to adopters; a company that integrates the code from your Eclipse project, for example, does so with confidence that the code in your project can legally be distributed under the agreed-to terms. The processes that we have in place are designed to support this. Ensure that you are familiar with the Eclipse Development Process (EDP), Eclipse IP Policy, and IP Due Diligence Process.

The EDP is mostly about community involvement. An Eclipse project is considered successful only if a vibrant community develops around it. While the reviews and processes described by the EDP may seem onerous, they are a necessary part of community development. You should anticipate spending a significant amount of time responding to questions posed in various forums (Eclipse Forums, mailing lists, or even Stack Overflow. You should plan on attending conferences (especially Eclipse Summit Europe and EclipseCon), presenting webinars, writing papers, etc to support your project.

There is tremendous value in the Eclipse IP Policy, but that value comes at a cost. It is important that you understand what is involved. Code provenance tracking is critical (we need to know the source of all code that ends up in our repositories). To that end, all new projects are required to make an initial contribution before any code is committed to an Eclipse source code repository (one implication of this requirement is that we assume that a new project starts from pre-existing code). The Eclipse IP Team will review your initial contribution to ensure that the code can distributed through an eclipse.org property. In effect, we review to code to make sure that it hasn't been copied inappropriately, that licenses are being used correctly, and so forth. As part of this process, the IP Team will research the source of all code; depending on the size of your contribution, this can be a time-consuming process. Furthermore, any third-party libraries required by your code will have to be checked and approved by the IP Team. As an Eclipse project you are expected to maintain an IP Log containing (among other things) information about all contributions and third-party libraries; you are required to submit this log for review and approval as part of the release process.

The Eclipse Foundation holds the trademark for all Eclipse projects. Trademark assignment is undertaken prior to the creation of any new project. If you already have a trademark on your project name, that trademark must be assigned to the Eclipse Foundation. Be advised that trademark assignment can be a time-consuming process (it can take hours, days, or weeks depending on the circumstances surrounding the name).

Here are some other links that should help you with the process:

This should sound like a lot of work. For many projects, the investment is worthwhile.