Skip to main content
Jump to: navigation, search

Difference between revisions of "Development Resources"

(Undo revision 205951 by (Talk))
Line 88: Line 88:
*[[Development Resources/Automatic IP Log|IP log]]  
*[[Development Resources/Automatic IP Log|IP log]]  
*[[Development Resources/Project Plan|project plan]]  
*[[Development Resources/Project Plan|project plan]]  
*[ custom term papers]
*[[Development Resources/HOWTO/Project Meta-Data|project meta-data]]  
*[[Development Resources/HOWTO/Project Meta-Data|project meta-data]]  
*[ custom research papers]
*[[Development Resources/HOWTO/Left Menu|"about this project" left menu]]  
*[[Development Resources/HOWTO/Left Menu|"about this project" left menu]]  
*[[Development Resources/HOWTO/Conforming Incubation Branding|incubation branding]]
*[[Development Resources/HOWTO/Conforming Incubation Branding|incubation branding]]

Revision as of 22:00, 2 August 2010

Users: Contributing To A 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 or SVN (each project makes their own choice).
  • 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.

Committers: Being A Committer

Committers and The Eclipse.Org Website

  • /projects - List of Projects. Your project is listed on the projects page automatically based on your project's meta-data (see below).
  • Standard Project Summary. Your project has a standard format project summary page (e.g., Project Dash). The summary page is driven by your project's meta-data (see below).
  • Standard Project Plan. Your project has a standard format project plan page (e.g., [1] for Project Dash). The project plan page is driven by your project's meta-data (see below) and has an entire page of documentation Development Resources/Project Plan.
  • IP Log. Your project has a standard format IP log (e.g., Project Dash). The IP log is driven by your project's meta-data (see below) and also has an entire page of documentation of its own.
  • Project Meta-Data. Many pieces of the infrastructure are driven by the project meta-data, thus it is important to keep the meta-data current and correct. Use the instructions and the portal to update the meta-data.
  • IT Infrastructure. Here is a general howto on using our IT infrastructure. More information is also available on the Webmaster FAQ.
  • Building and Maintaining a Project Website. The Phoenix project has documentation on building sites with the Phoenix API.
  • IT Infrastructure. IT Service Level Agreement
  • External Links. Links to content

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

  • Naming a Project. Help with choosing an appropriate name for your project [6].
  • 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. The IP log is a big part of the official release process, so 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.
  • Development Process. Official description of the meta-process for Eclipse projects. [7]
  • Reviews. At certain points during the process a project lead needs to initiate a Review.
  • 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.
  • 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. 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 [8].
  • 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.

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. [9] issues to be aware of, and the processes one should follow, when working as a committer on projects.
  • The Poster. The famous IP process poster [10].
  • The Policy. The official written word version of the due diligence process for contributing code [11].
  • The Cartoons. The IP Process in Eight Cartoons
  • The Legal Department. Licenses, IP policies, agreements, etc. [12]
  • Logos & Trademarks. Documents about the Eclipse logos and trademarks [13] [14]. 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

Back to the top