Jump to: navigation, search

Difference between revisions of "Development Resources"

(Projects: Ongoing)
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
== Community ==
 +
 +
*'''[[Community/Developer Hangouts | Developer Hangouts]]'''
 +
*'''[[Community/Getting Help | Getting Help]]'''
 +
*'''[[Community/Events | Events]]'''
 +
 
== Users: Contributing To A Project  ==
 
== Users: Contributing To A Project  ==
  
 +
*'''[[Development Resources/Quick Start -- Contributing Project Code|Quick Start -- Contributing Project Code]]''' Interested in contributing code. Awesome! This is how to get started.
 
*'''[[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.
 
*'''[[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.  
 
*'''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.  
Line 12: Line 19:
 
*'''[[Development Resources/Contributing via Git|Contributing via Git]]'''. Contributing to an Eclipse project using Git or Gerrit.
 
*'''[[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.
 
*:See also '''[[Development Resources/Handling Git Contributions|Handling Git Contributions]]''' from a committer's perspective.
 
== Eclipse RCP API Examples  ==
 
*[http://www.programcreek.com/java-api-examples/ API Examples]
 
  
 
== Projects: Getting Started ==
 
== Projects: Getting Started ==
Line 22: Line 26:
 
*'''[http://www.eclipse.org/projects/listofprojects.php List of Projects]''' All projects at Eclipse, including valuable links.
 
*'''[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.
 
*'''[[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)
 +
*'''Contribution Guide''' Consider including a contribution guide in the root of you Git repositories (see {{Bug|397644}}).
  
 
== Projects: Ongoing==
 
== Projects: Ongoing==
 
*'''[[Project Management Infrastructure|Project Management]]''' Project management, Project management infrastructure, and the Developer Portal.
 
*'''[[Project Management Infrastructure|Project Management]]''' Project management, Project management infrastructure, and the Developer Portal.
 +
*'''[[Development Resources/HOWTO/Release Cycle|Release Cycle]]''' Release cycle, and reviews.
 
* Various Policies and Guidelines
 
* Various Policies and Guidelines
 
** [[Development Resources/HOWTO/Project Naming Policy|The Eclipse Project Naming Policy]]
 
** [[Development Resources/HOWTO/Project Naming Policy|The Eclipse Project Naming Policy]]
Line 41: Line 48:
 
** [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/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]
 
** [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.
 +
*[[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
  
 
== Committers: Being A Committer  ==
 
== Committers: Being A Committer  ==
 
{{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.}}
 
{{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/Becoming a Committer|Becoming a Committer]]''' What do you need to do to become a committer on an Eclipse Project?
 
*'''[[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 Bootcamp|Committer Bootcamp]]''' Presentation, links, and help for new committers.
 
*'''[[Development Resources/New Commmitter Handbook|New Committer Handbook]]''' Helpful information and bits of advice for new committers.
 
*'''[[Development Resources/New Commmitter Handbook|New Committer 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.
 
*'''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.
Line 53: Line 64:
 
*'''Reaching out.''' [[Development Resources/Reaching out|Talking to other committers, requesting assistance, channels for communication.]]  
 
*'''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.  
 
*'''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].
+
*'''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).  
 
*'''[[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]].  
 
*'''Coding Guidelines.''' [[Development Conventions and Guidelines|Coding standards, naming conventions, version numbering, etc]].  
Line 68: Line 79:
  
 
*'''/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).  
 
*'''/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://www.eclipse.org/projects/project_summary.php?projectid=technology.dash Project Dash]). The summary page is driven by 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]].  
 
*'''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?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/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.
 
*'''[[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.''' Here is a general howto on using our [[IT Infrastructure Doc|IT infrastructure]]. More information is also available on the [[Webmaster FAQ]].  
Line 77: Line 88:
 
** [[IT Infrastructure Doc#Downloads | Downloads]]
 
** [[IT Infrastructure Doc#Downloads | Downloads]]
 
** [[IT SLA|IT Service Level Agreement]]
 
** [[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.  
+
*'''Building and Maintaining a Project Website.''' Eclipse project website development, code-named [[Phoenix]], has [[Using Phoenix|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]].
 
** 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]]
 
*'''External Links.''' [[Links to non-eclipse.org content]]
Line 97: Line 108:
 
*'''[[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/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/Creation Reviews|Creation Review]]'''
** '''[[Development Resources/HOWTO/Release Reviews|Release 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/Graduation Reviews|Graduation Review]]'''
 
** '''[[Development Resources/HOWTO/Restructuring Reviews|Restructuring Review]]'''
 
** '''[[Development Resources/HOWTO/Restructuring Reviews|Restructuring Review]]'''
** '''[[Development Resources/HOWTO/Termination Reviews|Termination Review]]'''
+
** '''[[Development Resources/HOWTO/Review Information for Project Leads#Termination_.28Archive.29_Reviews|Termination Review]]'''
 
*'''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.  
 
*'''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.
 
*'''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.
Line 108: Line 119:
 
**'''[[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/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.
 
*'''[[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.  
+
*'''Nominating and Electing New Committers.''' Use the [http://portal.eclipse.org portal] to nominate and elect new committers. Please follow the [[Development Resources/HOWTO/Nominating and Electing a New Committer|nomination guidelines]] so that the elections are relevant for the whole community.  
 
*'''Removing Inactive Committers.''' The [http://portal.eclipse.org/ portal] provides a simple tool for project leads to remove inactive committers (and to correct errors in the automatic inactive committer detection algorithm).  
 
*'''Removing Inactive Committers.''' The [http://portal.eclipse.org/ portal] provides a simple tool for project leads to remove inactive committers (and to correct errors in the automatic inactive committer detection algorithm).  
 
*'''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].  
 
*'''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].  

Revision as of 14:02, 15 May 2014

Community

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 either 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).
  • IP Due Diligence for Contributions. Certain processes must be followed. Dotting the i's and crossing the t's. It all starts with the Eclipse IP Due Diligence Poster, but there's a little something more (or less) for projects that use Git or Gerrit.
    • Note that the second page of the poster provides a list of approved third-party licenses.
  • 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.
  • 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

  • Starting a New Project Words of advice, what to expect, that sort of thing, ...
    • 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

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.
    • 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.
  • 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.
  • Migrating to Git Want to move your project off of CVS/SVN and over to Git?
    • 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 portal to nominate and elect new committers. Please follow the nomination guidelines so that the elections are relevant for the whole community.
  • Removing Inactive Committers. The portal provides a simple tool for project leads to remove inactive committers (and to correct errors in the automatic inactive committer detection algorithm).
  • 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

This page is moderated by the EMO