Skip to main content
Jump to: navigation, search

Difference between revisions of "Development Resources"

(Getting Answers: Add news groups link)
(Committers and The Eclipse.Org Website)
 
(263 intermediate revisions by 27 users not shown)
Line 1: Line 1:
=Reporting Bugs=
+
<!--
 +
== Community ==
  
* [https://bugs.eclipse.org/bugs/ Bug Reports]
+
*'''[[Community/Developer Hangouts | Developer Hangouts]]'''
* [[Field Guide to Callisto Bugs]]
+
*'''[[Community/Getting Help | Getting Help]]'''
Eclipse uses Bugzilla as our bug tracking system. Bugzilla has a wide following within the open source community and directly supports the workflows associated with distributed development (e.g., email notification). You can sign up for your own Eclipse bugzilla ID and start contributing bug reports.
+
*'''[[Community/Events | Events]]'''
 +
-->
  
=Getting Answers=
+
== Users: Contributing To A Project  ==
  
* [http://www.eclipse.org/mail/ Mailing Lists]
+
*'''[[Development Resources/Quick Start -- Contributing Project Code|Quick Start -- Contributing Project Code]]''' Interested in contributing code. Awesome! This is how to get started.
Eclipse uses mailing lists for development coordination, design discussions, voting, announcements etc.
+
*'''[[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 [[Git]].
 +
*'''[[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 [https://www.eclipse.org/projects/handbook/#ip Intellectual Property] content in the handbook, 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]].
 +
** Project Leads should be familiar with the list of approved (and unapproved) [https://www.eclipse.org/legal/licenses.php Third Party Content Licenses]
 +
*'''[[Development Resources/Contributing via Git|Contributing via Git]]'''. Contributing to an Eclipse project using Git or Gerrit.
 +
*:See also '''[[Development Resources/Handling Git Contributions|Handling Git Contributions]]''' from a committer's perspective.
  
* [http://www.eclipse.org/newsgroups/ News Groups]
+
== Projects: Getting Started ==
News Groups are open to the whole community, and are open to a broader range of questions than mailing lists.
+
*'''[https://www.eclipse.org/projects/handbook Eclipse Project Handbook]''' An overview of (almost) everything you need to know about starting, running, and participating in an Eclipse project.
 +
*'''[https://www.eclipse.org/projects/handbook/#starting Starting a New Open Source Eclipse Project]''' Words of advice, what to expect, that sort of thing, ...
 +
**Should you create a '''[[Development Resources/HOWTO/Starting A New Project/Subproject or Component|Subproject or Component?]]'''
 +
**'''[[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.
 +
*'''[[Social Coding]]''' Git, Gerrit, CLAs, and hosting your Eclipse Foundation project with another hosting service (e.g. GitHub)
 +
*'''[[Architecture Council/Contributor Guide Recommendation|Contribution Guide]]''' Consider including a contribution guide in the root of you Git repositories (see {{Bug|397644}}).
  
* [[IRC]]
+
== Projects: Ongoing==
Asking questions on the IRC channels can be a quick way to get your questions answered, if the right person is online.
+
*'''[https://www.eclipse.org/projects/handbook/#pmi Project Management Infrastructure] (PMI)''' Manage information about your project
 +
** There's also [[Project Management Infrastructure|PMI, APIs, etc.]]  
 +
*'''[https://www.eclipse.org/projects/handbook/#release Release Cycle]''' Release cycle, and reviews.
 +
*[[Architecture Council/Contributor Guide Recommendation|Contribution Guide Recommendations]] from the Architecture Council
 +
** All Git repositories must have a [[Architecture Council/Contributor Guide Recommendation#Source Code Repositories|CONTRIBUTING file]] or an equivalent
  
=Getting Code=
+
===Policies and Guidelines===
 +
Here's a list of various policies and guidelines for Eclipse projects.
  
* [http://download.eclipse.org/ Eclipse Platform downloads page]
+
* [[Development Resources/HOWTO/Project Naming Policy|The Eclipse Project Naming Policy]]
Links to Nightly, Milestone and Maintenance builds, plus release notes, performance results, and other Platform goodies.
+
* [[Development Resources/HOWTO/The Eclipse Code Namespace Policy|The Eclipse Code Namespace Policy]]
* [http://dev.eclipse.org/viewcvs/ CVS Repository]
+
* [[Version_Numbering|The Eclipse Version Numbering Policy]]
We use the Concurrent Versioning System (CVS) to support concurrent distributed development, and we use Eclipse as our CVS client because it supports CVS directly.. All Eclipse development is carried out in this repository. The server supports both "extssh" and "pserver" type CVS connections - "pserver" only works for anonymous access.
+
* [http://eclipse.org/security/policy.php The Eclipse Security Policy]
 +
* [http://www.eclipse.org/legal/privacy.php The Eclipse Privacy Policy]
 +
* [http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf The Eclipse Intellectual Property Policy]
 +
* [http://www.eclipse.org/org/documents/Eclipse_Policy_and_Procedure_for_3rd_Party_Dependencies_Final.pdf Guidelines for the Review of Third Party Dependencies]
 +
* [http://www.eclipse.org/legal/logo_guidelines.php Guidelines for Eclipse Logos & Trademarks]
 +
* [[Links to non-eclipse.org content|Guidelines for Links to non-eclipse.org content]] on your project website
 +
* [[User Interface Guidelines]]
 +
* [http://eclipse.org/org/documents/Eclipse_Using_Proprietary_Tools_Final.php Guidelines for the Use of Proprietary Tools]
 +
* [http://eclipse.org/org/documents/Eclipse_SpecOrgs_final.pdf Eclipse Foundation Policy on Interacting with Standards and Specification Organizations]
 +
* [http://eclipse.org/org/documents/Licensing_Example_Code.pdf Licensing of Examples]
 +
* [http://eclipse.org/org/documents/LGPL_API_Policy.pdf Policy to Consider the Limited Usage of LGPL APIs in Eclipse Projects]
 +
* [http://eclipse.org/org/documents/Eclipse%20ANTITRUST%202003_11_10%20Final.pdf Eclipse Foundation Antitrust Compliance Policy]
 +
* [[Policies/Uploading and Downloading from Eclipse Software Policy|Uploading and Downloading from Eclipse Software Policy]] '''Work in progress.''' A policy concerning project software that uploads or downloads.
 +
* [https://www.eclipse.org/org/documents/Recognizing_Project_Contributions_Policy_2008.pdf Policy on Recognizing Contributions on Project Web Sites]
  
=Committing Patches=
+
* [[Development Resources/Incubation FAQ|Incubation FAQ]]
 +
* [[Bug Reporting FAQ]]
 +
* [[Webmaster FAQ]]
  
* [[Development Conventions and Guidelines]]
+
== Committers: Being A Committer  ==
Look here for the for the coding standards, naming conventions, and other guidelines we use to help ensure eclipse presents to users and developers as a unified whole rather than as a loose collection of parts.
+
{{Warning|The Project Management elements of the Developer Portal are being moved to the new [[Project Management Infrastructure]]. All project metadata can now be edited directly on project summary/information pages. Committer elections and creation of new CQs for the IP due diligence process must still be done using the Developer Portal. We are in the process of updating documentation.}}
 +
*'''[[Development Resources/Committer Cheat Sheet|Committer Cheat Sheet]]''' The concise list of things that you need to know when you're a committer.
 +
*'''[[Development Resources/Becoming a Committer|Becoming a Committer]]''' What do you need to do to become a committer on an Eclipse Project?
 +
*'''[[Development Resources/Committer Orientation|Committer Orientation]]''' A short presentation that introduces the basics of open source project participation.
 +
*'''[[Development Resources/Committer Bootcamp|Committer Bootcamp]]''' Presentation, links, and help for new committers.
 +
*'''[http://www.eclipse.org/projects/handbook Eclipse Project Handbook]''' Helpful information and bits of advice for new committers.
 +
*'''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.
 +
*'''[[Project Management Infrastructure]]''' Use the project management infrastructure to manage information about your project, including project descriptions, releases, reviews, and more.
 +
*'''Reaching out.''' [[Development Resources/Reaching out|Talking to other committers, requesting assistance, channels for communication.]]
 +
*'''Community Development''' [[Community Development for Eclipse Projects|Developing a community]] and Eco-system around your project is every committer's job.
 +
*'''APIs''' See [[Eclipse/API_Central]]. The Eclipse Project also provides some [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).
 +
*'''Coding Guidelines.''' [[Development Conventions and Guidelines|Coding standards, naming conventions, version numbering, etc]].
 +
*'''Difficult People.''' Some advice on interacting with sometimes frustrating users [[Mylyn Contributor Reference#Communication]].
 +
*'''[[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/Handling Git Contributions|Handling Git Contributions]]'''. Contributions from Git outside Git repositories are subject to our IP Policy and Due Diligence Process.
 +
**'''[[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.
  
* [https://dev.eclipse.org/committers/ Committer tools]
+
=== Committers and The Eclipse.Org Website  ===
Eclipse committers can use this interface to change their eclipse.org password, to run some stats or to get general information about the eclipse.org infrastructure.
+
  
* [http://www.eclipse.org/legal/newcommitter.php Add a New Committer]
+
*'''/projects - List of Projects.''' Your project is listed on the [http://www.eclipse.org/projects/listofprojects.php projects] page automatically based on your project's metadata (see below).
 +
*'''Standard Project Summary.''' Your project has a standard format [[Development Resources/Project Summary Page | project summary page]] (e.g., [http://projects.eclipse.org/projects/technology.dash Project Dash]). The summary page is driven by your [[Project Management Infrastructure/Project Metadata|project's metadata]].
 +
*'''Standard Project Plan.''' Your project has a standard format project plan page (e.g., [http://www.eclipse.org/projects/project-plan.php?projectid=technology.dash] for Project Dash). The project plan page is driven by your project's metadata (see below) and has an entire page of documentation [[Development Resources/Project Plan]].
 +
*'''[[Development Resources/IP Log | IP Log]].''' Your project has a standard format IP log (e.g., [http://www.eclipse.org/projects/ip_log.php?id=technology.dash Project Dash]). [[Development Resources/Automatic IP Log|The Automatic IP Log Generator]] is driven by your [[Project Management Infrastructure/Project Metadata|project's metadata]].
 +
*'''[[Project Management Infrastructure/Project Metadata|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. This includes basic information about projects including description, scope, and repositories; releases; reviews; and more.
 +
*'''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.''' All Eclipse Projects have an automatically-generated [[Development Resources/Data Driven Project Website|Data-Driven Project Website]]. Project teams can opt to create and maintain a [https://www.eclipse.org/projects/handbook/#resources-website custom 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.
 +
* 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.
 +
** '''[[Development Resources/HOWTO/Creation Reviews|Creation Review]]'''
 +
** '''[[Development Resources/HOWTO/Release Cycle|Release Cycle]]''' and '''[[Development Resources/HOWTO/Release Reviews|Release Review]]'''
 +
** '''[[Development Resources/HOWTO/Graduation Reviews|Graduation Review]]'''
 +
** '''[[Development Resources/HOWTO/Restructuring Reviews|Restructuring Review]]'''
 +
** '''[[Development Resources/HOWTO/Review Information for Project Leads#Termination_.28Archive.29_Reviews|Termination Review]]'''
 +
*'''Manage Project Metadata, Bugzilla Components, etc.''' Project metadata is captured in the [https://eclipse.org/projects/handbook/#pmi Project Management Interface] (PMI), which feeds the [http://projects.eclipse.org/projects project information pages] and other tools. In the metadata, you specify important information like release dates, project plans, and description. Many project-related tools are accessible from here; additional tools (e.g. Bugzilla configuration) are available to committers via their [http://accounts.eclipse.org Eclipse Foundation Account] page.
 +
*'''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/TCK Access|TCK Access]]''' Information regarding Technology Compatibility Kit (TCK) use by Eclipse Projects.
 +
**'''[[Development Resources/Handling Git Contributions|Handling Git Contributions]]'''. Contributions from Git outside Git repositories are subject to our IP Policy and Due Diligence Process.
 +
*'''[[Development Resources/Changing Leadership|Changing Leadership]]''' Electing new Project Leads and retiring the used up ones.
 +
*'''Nominating and Electing New Committers.''' Use the [https://www.eclipse.org/projects/handbook/#elections-how PMI] to nominate and elect new committers. Please follow the [https://www.eclipse.org/projects/handbook/#elections-committer nomination guidelines] so that the elections are relevant for the whole community.
 +
*'''Removing Inactive Committers.''' Project leads can visit the "Who's Involved" tab of the [https://www.eclipse.org/projects/handbook/#pmi-project-page Project Page], click on a committer, and use the "Retire Committer Status" box to retire a committer.
 +
*'''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.
 +
*'''The IP Due Diligence/Legal Process Poster.''' The famous IP [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf process poster].
 +
*'''The Policy.''' The official written word version of the due diligence process for contributing code [http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf].
 +
*'''The Cartoons.''' [http://www.eclipse.org/projects/dev_process/ip-process-in-cartoons.php The IP Process in Eight Cartoons]
 +
*'''The Legal Department.''' Licenses, IP policies, agreements, etc. [http://www.eclipse.org/legal/]
 +
*'''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.
 +
*'''More IP Stuff.'''  See [[IP Stuff | IP Stuff]]
 +
 
 +
== FAQs and Guidelines ==
 +
 
 +
*Guidelines for the [[Development Resources/HOWTO/Pre-Proposal Phase|Pre-Proposal Phase]]
 +
*Guidelines for the [[Development Resources/HOWTO/Proposal Phase|Proposal Phase]]
 +
*Guidelines for the [[Development Resources/HOWTO/Incubation Phase|Incubation Phase]]
 +
*Guidelines for Using the [[Development Resources/HOWTO/Parallel IP Process|Parallel IP Process]]
 +
*Guidelines for the [[Development Resources/HOWTO/Mature Phase|Mature Phase]]
 +
*Guidelines for the [[Development Resources/HOWTO/Archived Phase|Archived Phase]]
 +
*Guidelines for [[Development Resources/HOWTO/Creation Reviews|Creation Reviews]]
 +
*Guidelines for [[Development Resources/HOWTO/Graduation Reviews|Graduation Reviews]]
 +
*Guidelines for [[Development Resources/HOWTO/Release Reviews|Release Reviews]]
 +
*[[User Interface Guidelines]]
 +
*[[Eclipse Quality]]
 +
*[[Development Resources/HOWTO/Project Naming Policy|Project Naming Policy]]
 +
 
 +
== HOWTOs and Help ==
 +
 
 +
*[[EPP/How to create a package|How to Create an EPP Package]]. Creating and maintaining a package for distribution from [http://www.eclipse.org/downloads the Eclipse Downloads] page.
 +
*[[Development Resources/HOWTO/Bugzilla Use|Bugzilla Use]]
 +
*[[Development Resources/Automatic IP Log|Using the Automatic IP Log Generator]]
 +
*Maintaining a [[Development Resources/Project Plan|Project Plan]]
 +
*Maintaining [[Development Resources/HOWTO/Project Meta-Data|Project Metadata]]
 +
*[[Development Resources/HOWTO/Left Menu|"About this project"]] on the Project website
 +
*[https://www.eclipse.org/projects/handbook/#starting-incubation-branding Incubation Branding] and the [[Development Resources/HOWTO/Parallel IP Process|Parallel IP Process]]
 +
 
 +
= Information and Miscellany =
 +
 
 +
*[[http://www.eclipse.org/projects/lists.php Lists of committers]]
 +
 
 +
 
 +
= Website =
 +
 
 +
This section details website specific information, both for the Eclipse.org and project specific pages.
 +
 
 +
* [[Development Resources/web_site_refresh | Web Site Refresh]]
 +
 
 +
 
 +
= Marketplace =
 +
 
 +
* [https://marketplace.eclipse.org/quickstart Quick Start]
 +
 
 +
= EMO Processes =
 +
 
 +
*'''[[Development Resources/Processes | Processes]]'''
 +
 
 +
 
 +
''This page is moderated by the EMO''
 +
 
 +
[[Category:Development_Resources]] [[Category:How_to_Contribute]] [[Category:Architecture_Council]]

Latest revision as of 12:39, 26 February 2021


Users: Contributing To A Project

  • Quick Start -- Contributing Project Code Interested in contributing code. Awesome! This is how to get started.
  • 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 Git.
  • 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).
  • IP Due Diligence for Contributions. Certain processes must be followed. Dotting the i's and crossing the t's. It all starts with the Intellectual Property content in the handbook, but there's a little something more (or less) for projects that use Git or Gerrit.
  • Contributing via Git. Contributing to an Eclipse project using Git or Gerrit.
    See also Handling Git Contributions from a committer's perspective.

Projects: Getting Started

  • Eclipse Project Handbook An overview of (almost) everything you need to know about starting, running, and participating in an Eclipse project.
  • Starting a New Open Source Eclipse Project Words of advice, what to expect, that sort of thing, ...
    • Should you create a Subproject or Component?
    • Naming a Project. Help with choosing an appropriate name for your project.
    • 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.
  • List of Projects All projects at Eclipse, including valuable links.
  • 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.
  • Social Coding Git, Gerrit, CLAs, and hosting your Eclipse Foundation project with another hosting service (e.g. GitHub)
  • Contribution Guide Consider including a contribution guide in the root of you Git repositories (see bug 397644).

Projects: Ongoing

Policies and Guidelines

Here's a list of various policies and guidelines for Eclipse projects.

Committers: Being A Committer

Warning2.png
The Project Management elements of the Developer Portal are being moved to the new Project Management Infrastructure. All project metadata can now be edited directly on project summary/information pages. Committer elections and creation of new CQs for the IP due diligence process must still be done using the Developer Portal. We are in the process of updating documentation.

Committers and The Eclipse.Org Website

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

  • Eclipse Development Process (EDP) Official description of the meta-process for Eclipse projects.
  • 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.
  • 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 is captured in the Project Management Interface (PMI), which feeds the project information pages and other tools. In the metadata, you specify important information like release dates, project plans, and description. Many project-related tools are accessible from here; additional tools (e.g. Bugzilla configuration) are available to committers via their Eclipse Foundation Account page.
  • About Files and Copyright Notices. There's the official guide to legal documentation and then there's a slightly different, but perhaps more readable, guide to legal documentation from the developers point of view. More directly, there's the 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 well-defined release review process. It's relatively simple, but it does require planning ahead to schedule the necessary legal and community reviews.
  • TCK Access Information regarding Technology Compatibility Kit (TCK) use by Eclipse Projects.
    • Handling Git Contributions. Contributions from Git outside Git repositories are subject to our IP Policy and Due Diligence Process.
  • Changing Leadership Electing new Project Leads and retiring the used up ones.
  • Nominating and Electing New Committers. Use the PMI to nominate and elect new committers. Please follow the nomination guidelines so that the elections are relevant for the whole community.
  • Removing Inactive Committers. Project leads can visit the "Who's Involved" tab of the Project Page, click on a committer, and use the "Retire Committer Status" box to retire a committer.
  • 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.

New Project Leads

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 guide to legal documents describes what legal documents to include with code and deliverable software.
  • Committer Guidelines. [7] issues to be aware of, and the processes one should follow, when working as a committer on Eclipse.org projects.
  • Third Party Dependencies. This document contains the guidelines for the review of third-party dependencies.
  • The IP Due Diligence/Legal Process Poster. The famous IP process poster.
  • The Policy. The official written word version of the due diligence process for contributing code [8].
  • The Cartoons. The IP Process in Eight Cartoons
  • The Legal Department. Licenses, IP policies, agreements, etc. [9]
  • 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.
  • More IP Stuff. See IP Stuff

FAQs and Guidelines

HOWTOs and Help

Information and Miscellany


Website

This section details website specific information, both for the Eclipse.org and project specific pages.


Marketplace

EMO Processes


This page is moderated by the EMO

Back to the top