*'''[[Development Resources/How To Behave|How To Behave]]''' Practical advice on how to ask questions, report bugs, and be generally successful in your interactions with an Open Source Project.

+

*'''Reporting Bugs.''' All Eclipse projects use [https://bugs.eclipse.org/bugs/ Bugzilla] to track bugs and features. Please read the [[Bug Reporting FAQ]] and then sign up for a bugzilla account to join in the fun.

+

*'''Getting Answers.''' [http://www.eclipse.org/mail/ Mailing lists] are for development team conversations; [http://www.eclipse.org/newsgroups/ newsgroups] and [[IRC]] are for the larger user and adopter community and thus are the correct place to ask for help.

+

*'''Downloads.''' Get binaries from the [http://www.eclipse.org/downloads/ main downloads page]. Click through to the project pages for integration, milestone, and nightly builds.

+

*'''Source Code.''' Get the source code from either [[CVS Howto|CVS]], [[SVN Howto|SVN]], or [[Git]] (each project makes their own choice).

+

*'''[[Development Resources/Contributing|Contribute!]]''' The best way to contribute to a project is to contribute (sorry for the recursion). Pick a bug from a project that interests you, build a fix, and contribute it to the bug as a patch. If you're not sure how to start, ask questions on the bug, or communicate with the [http://www.eclipse.org/projects/listofprojects.php project] via their communication channel (normally a [http://www.eclipse.org/forums/ forum]).

+

*'''IP Due Diligence for Contributions'''. Certain processes must be followed. Dotting the i's and crossing the t's. It all starts with the [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf Eclipse IP Due Diligence Poster], but there's a little [[Development Resources/IP Due Diligence for Git and Gerrit|something more (or less) for projects that use Git or Gerrit]].

+

*'''Large Contributions.''' Small contributions to Eclipse projects should be made through [https://bugs.eclipse.org/bugs/ Bugzilla], but larger contributions require a [[TM and RSE FAQ#How_do_I_submit_a_contribution_beyond_a_simple_bug_fix.3F|separate process]]. Or, if the contribution is larger still, you could [[Development Resources/HOWTO/Starting A New Project|start a new project]].

*'''[[Development Resources/HOWTO/Starting A New Project|Starting a New Project]]''' Words of advice, what to expect, that sort of thing, ...

+

**'''[[Development Resources/HOWTO/Project Naming Policy | Naming a Project]]'''. Help with choosing an appropriate name for your project.

+

**'''[[Development Resources/Initial Contribution|Initial Contribution]]''' All Eclipse projects start with an initial contribution of code. Some contributions are big, other are small. Whatever the case, the IP Team needs to review your first drop of code before anything gets added to the repository.

+

*'''[http://www.eclipse.org/projects/listofprojects.php List of Projects]''' All projects at Eclipse, including valuable links.

+

*'''[[Development Resources/The First 90 Days|The First 90 Days]]''' What to expect, and what you need to do during the first 90 days with your brand spanking new Eclipse Project.

*'''Eclipse Development Process.''' The [http://www.eclipse.org/projects/dev_process/development_process.php Eclipse Development Process] (EDP) describes the high-level development process for Eclipse projects. Individual projects set their own day-to-day development process.

+

*'''Becoming a Committer.''' The Standard Project Charter's [http://www.eclipse.org/projects/dev_process/Eclipse_Standard_TopLevel_Charter_v1.1.php#Committers Committers] section has some information. The Eclipse Development Process document's section on [http://www.eclipse.org/projects/dev_process/development_process.php#4_7_Committers_and_Contributors Committers and Contributors] has more.

+

*'''Portal.''' The [http://portal.eclipse.org/ portal] is designed to be your single point of contact with the Foundation and to guide you through the various Foundation processes.

+

*'''Map.''' [http://www.zeemaps.com/Eclipsecommittersworldwide Map of Committers and Contributors]. Put yourself on the map!

*'''Community Development''' [[Community Development for Eclipse Projects|Developing a community]] and Eco-system around your project is every committer's job.

+

*'''APIs''' The Eclipse Project provides some great [http://www.eclipse.org/eclipse/development/ API Resources].

+

*'''[[Development Resources/Words of Wisdom and Bits of Advice|Words of Wisdom and Bits of Advice]]'''. Things that Eclipse Project leads and committers need, and should, be doing on a regular basis (daily/weekly/weekly/quarterly/etc).

*'''[[Friends of Eclipse/Funds Allocation|Friends of Eclipse Funding]]'''. Some money is available from the Eclipse Foundation to help your project pay for meeting space, hardware, and other expenses (sorry, we can't pay committers).

+

* '''[[Development Resources/How to Use Eclipse Copyright Tool|How to Use the Eclipse Copyright Tool]].''' The Eclipse Project's [[Platform-releng-faq#How do I use the releng plugin?|Releng Tools]] plug-in provides--among other things--a handy tool that can help you get your [http://eclipse.org/legal/copyrightandlicensenotice.php copyright headers] right.

+

*Intellectual Property Management

+

**'''Cartoons.''' Quick reference guides in a fun and easy format: [http://www.eclipse.org/projects/dev_process/ip-process-in-cartoons.php The IP Process in Eight Cartoons] and [http://www.eclipse.org/projects/dev_process/three-laws-of-eclipse.php The Three Laws of Eclipse].

**'''[[Development Resources/Contribution Questionnaire|Contribution Questionnaire]] (CQ)'''. Managing intellectual property contributions, including discussion of when you need a CQ for a third party library.

+

**'''[[Development Resources/IP/Test and Build Dependencies|Test and Build Dependencies]]'''. Special considerations for libraries that are not strictly distributed by the project, but rather are as build and test time.

*'''[[Development Resources/IP Log | IP Log]].''' Your project has a standard format IP log (e.g., [http://www.eclipse.org/projects/ip_log.php?projectid=technology.dash Project Dash]). The IP log is driven by your project's metadata (see below) and also has an entire page of documentation of its own. You can access the IP Log generator [http://www.eclipse.org/projects/ip_log.php here].

+

*'''[[Development Resources/HOWTO/Project Meta-Data|Project Metadata]].''' Many pieces of the eclipse.org infrastructure are driven by the project metadata, thus it is important to keep the metadata current and correct. Use [[Development Resources/HOWTO/Project Meta-Data|the instructions]] and [http://portal.eclipse.org the portal] to update the metadata.

+

*'''IT Infrastructure.''' Here is a general howto on using our [[IT Infrastructure Doc|IT infrastructure]]. More information is also available on the [[Webmaster FAQ]].

+

** [[IT Infrastructure Doc#Bugzilla | Bugzilla]]

+

** [[IT Infrastructure Doc#Builds | Builds]]

+

** [[IT Infrastructure Doc#Downloads | Downloads]]

+

** [[IT SLA|IT Service Level Agreement]]

+

*'''Building and Maintaining a Project Website.''' The [[Phoenix]] project has [[Phoenix Documentation|documentation]] on building sites with the Phoenix API.

+

** Alternatively, you can opt to use the automatically-generated [[Development Resources/Data Driven Project Website|Data-Driven Project Website]].

+

*'''External Links.''' [[Links to non-eclipse.org content]]

+

+

=== New Committers ===

+

+

*'''Legal Paperwork.''' Becoming a new committer involves some legal paperwork. Here's what and why [http://www.eclipse.org/projects/dev_process/new-committer.php#Paperwork]

+

*'''Development Process.''' For the overall smooth flow of the Eclipse eco-system, committers agree to follow a few process rules. Here's what they are [http://www.eclipse.org/projects/dev_process/development_process.php]. There's also a more humorous summary version [http://www.eclipse.org/projects/dev_process/three-laws-of-eclipse.php].

+

*'''Parallel IP Process.''' Many new committers join with a block of code that they'd like to include right away. The Parallel IP process is designed to speed that inclusion. Here's the what, why, and how of that process [http://www.eclipse.org/projects/dev_process/parallel-ip-process.php].

+

+

== Leads: Managing A Project ==

+

*'''[http://www.eclipse.org/projects/dev_process/development_process.php Eclipse Development Process] (EDP)''' Official description of the meta-process for Eclipse projects.

+

*'''[[Development Resources/IP Log|IP log]]''' Your project must maintain an IP Log. This document keeps track of third-party libraries used and distributed by the project, contributions, and more. It is especially important for adopters who need to know where the intellectual property of your project comes from. You are required to provide an IP Log prior to a release review. We encourage you to keep your IP log current rather than rushing at the end. The [[Development Resources/Automatic IP Log|automatic IP log]] extracts most information from bugzilla and IPzilla, but it requires you to use the 'iplog+' flag.

+

*'''[[Development Resources/Project Plan|Project Plan]]''' The project plan is how projects communicate their future intent to the rest of the Eclipse community.

+

*'''[[Development Resources/Builds|Builds]]''' You have some options with regard to how you build your Eclipse project for distribution.

+

**'''[[Hudson]]''' Some information about Hudson-based builds, including requesting a new job.

+

* Code quality analysis

+

**'''[[Sonar]]''' is available for Eclipse projects to track and improve the quality of their code.

+

*'''[[Development Resources/HOWTO/Review Information for Project Leads|Reviews]]''' Reviews are undertaken a key points in the life of a project. Project leads should coordinate reviews with their PMC and the EMO.

*'''Manage Project Metadata, Bugzilla Components, etc.''' Project metadata feeds the [http://www.eclipse.org/projects/project_summary.php?projectid=technology project summary pages] and other Eclipse tools. In the metadata, you specify important information like release dates, project plans, and description. Use the "Eclipse Projects" section on the [http://portal.eclipse.org portal] to specify project metadata. The "tools for all committers" link provides access to Bugzilla components.

+

*'''About Files and Copyright Notices.''' There's the official [http://www.eclipse.org/legal/guidetolegaldoc.php guide to legal documentation] and then there's a slightly different, but perhaps more readable, [http://www.eclipse.org/legal/guidetolegaldoc2.php guide to legal documentation from the developers point of view]. More directly, there's the [http://eclipse.org/legal/copyrightandlicensenotice.php Default Eclipse Foundation Copyright and License Notice] page.

+

*'''Releases.''' Of course the whole point of an Eclipse project is to release code to the community. At the same time, the Eclipse community relies on a [http://www.eclipse.org/projects/dev_process/release-review.php well-defined release review process]. It's relatively simple, but it does require planning ahead to schedule the necessary legal and community reviews.

*'''[[Development Resources/Changing Leadership|Changing Leadership]]''' Electing new Project Leads and retiring the used up ones.

+

*'''Nominating and Electing New Committers.''' Use the [http://portal.eclipse.org portal] to nominate and elect new committers (you can review the portal workflow [https://dev.eclipse.org/portal/myfoundation/tests/swim.php?file=committer_election/committer_election.txt&lines= here]). Please follow the [[Development Resources/HOWTO/Nominating and Electing a New Committer|nomination guidelines]] so that the elections are relevant for the whole community.

*'''Press Releases.''' The Eclipse Foundation's marketing department would like to help you put out your project-related press releases; the guidelines are simple enough [http://www.eclipse.org/org/press-release/pressguidelines.htm].

+

*'''Creating and Managing Mailing Lists and Newsgroups''' Newsgroups are used by most projects to communicate with their community. Mailing lists tend to be used for communication amongst project developers (committers and contributors). Contact [mailto:webmaster@eclipse.org Webmaster] to create and manage [http://www.eclipse.org/newsgroups/index_all.php newsgroups] and [http://www.eclipse.org/mail/index_all.php mailing lists].

+

*'''Team calls''' You can request a dedicated [[Asterisk]] conference call line for your project.

+

+

=== New Project Leads ===

+

+

*'''Sufficient Community.''' What does it mean to have a project mature enough to graduate? See [[Community Development for Eclipse Projects]] for the Technology PMC's current thoughts on the issue.

+

+

== Everyone: IP Cleanliness ==

+

Maintaining intellectual property (IP) cleanliness is a critical part of being an Eclipse project, committer, and community member.

+

+

*'''The Official Story.''' The [http://www.eclipse.org/legal/guidetolegaldoc2.php guide to legal documents] describes what legal documents to include with code and deliverable software.

+

*'''Committer Guidelines.''' [http://www.eclipse.org/legal/committerguidelines.php] issues to be aware of, and the processes one should follow, when working as a committer on Eclipse.org projects.

+

*'''[http://www.eclipse.org/org/documents/Eclipse_Policy_and_Procedure_for_3rd_Party_Dependencies_Final.pdf Third Party Dependencies].''' This document contains the guidelines for the review of third-party dependencies.

*'''Logos &amp; Trademarks.''' Documents about the Eclipse logos and trademarks [http://www.eclipse.org/legal/logo_guidelines.php] [http://www.eclipse.org/artwork/index.php]. The Eclipse Foundation owns the trademarks on all the Eclipse Project names. The Foundation holds these trademarks on behalf of, and for the benefit of, the projects.

Users: Contributing To A Project

How To Behave Practical advice on how to ask questions, report bugs, and be generally successful in your interactions with an Open Source Project.

Reporting Bugs. All Eclipse projects use Bugzilla to track bugs and features. Please read the Bug Reporting FAQ and then sign up for a bugzilla account to join in the fun.

Getting Answers.Mailing lists are for development team conversations; newsgroups and IRC are for the larger user and adopter community and thus are the correct place to ask for help.

Downloads. Get binaries from the main downloads page. Click through to the project pages for integration, milestone, and nightly builds.

Source Code. Get the source code from either CVS, SVN, or Git (each project makes their own choice).

Contribute! The best way to contribute to a project is to contribute (sorry for the recursion). Pick a bug from a project that interests you, build a fix, and contribute it to the bug as a patch. If you're not sure how to start, ask questions on the bug, or communicate with the project via their communication channel (normally a forum).

Large Contributions. Small contributions to Eclipse projects should be made through Bugzilla, but larger contributions require a separate process. Or, if the contribution is larger still, you could start a new project.

Eclipse RCP API Examples

Projects: Getting Started

Initial Contribution All Eclipse projects start with an initial contribution of code. Some contributions are big, other are small. Whatever the case, the IP Team needs to review your first drop of code before anything gets added to the repository.

IP Log. Your project has a standard format IP log (e.g., Project Dash). The IP log is driven by your project's metadata (see below) and also has an entire page of documentation of its own. You can access the IP Log generator here.

Project Metadata. Many pieces of the eclipse.org infrastructure are driven by the project metadata, thus it is important to keep the metadata current and correct. Use the instructions and the portal to update the metadata.

New Committers

Legal Paperwork. Becoming a new committer involves some legal paperwork. Here's what and why [2]

Development Process. For the overall smooth flow of the Eclipse eco-system, committers agree to follow a few process rules. Here's what they are [3]. There's also a more humorous summary version [4].

Parallel IP Process. Many new committers join with a block of code that they'd like to include right away. The Parallel IP process is designed to speed that inclusion. Here's the what, why, and how of that process [5].

Leads: Managing A Project

IP log Your project must maintain an IP Log. This document keeps track of third-party libraries used and distributed by the project, contributions, and more. It is especially important for adopters who need to know where the intellectual property of your project comes from. You are required to provide an IP Log prior to a release review. We encourage you to keep your IP log current rather than rushing at the end. The automatic IP log extracts most information from bugzilla and IPzilla, but it requires you to use the 'iplog+' flag.

Project Plan The project plan is how projects communicate their future intent to the rest of the Eclipse community.

Builds You have some options with regard to how you build your Eclipse project for distribution.

Hudson Some information about Hudson-based builds, including requesting a new job.

Code quality analysis

Sonar is available for Eclipse projects to track and improve the quality of their code.

Reviews Reviews are undertaken a key points in the life of a project. Project leads should coordinate reviews with their PMC and the EMO.

Manage Project Metadata, Bugzilla Components, etc. Project metadata feeds the project summary pages and other Eclipse tools. In the metadata, you specify important information like release dates, project plans, and description. Use the "Eclipse Projects" section on the portal to specify project metadata. The "tools for all committers" link provides access to Bugzilla components.

Releases. Of course the whole point of an Eclipse project is to release code to the community. At the same time, the Eclipse community relies on a well-defined release review process. It's relatively simple, but it does require planning ahead to schedule the necessary legal and community reviews.

Nominating and Electing New Committers. Use the portal to nominate and elect new committers (you can review the portal workflow here). Please follow the nomination guidelines so that the elections are relevant for the whole community.

Press Releases. The Eclipse Foundation's marketing department would like to help you put out your project-related press releases; the guidelines are simple enough [6].

Creating and Managing Mailing Lists and Newsgroups Newsgroups are used by most projects to communicate with their community. Mailing lists tend to be used for communication amongst project developers (committers and contributors). Contact Webmaster to create and manage newsgroups and mailing lists.

Team calls You can request a dedicated Asterisk conference call line for your project.

Logos & Trademarks. Documents about the Eclipse logos and trademarks [10][11]. The Eclipse Foundation owns the trademarks on all the Eclipse Project names. The Foundation holds these trademarks on behalf of, and for the benefit of, the projects.