Protocols for Project Proposal
2005-10
- Types of Projects
- Proposing a Project: General Information
- Incubator Projects
- Native Language Confederation (NLC) Projects
- Setting Up The Project
About This Document
This document explains how to go about proposing and setting up a project.
Only registered members of OpenOffice.org may propose projects.
Further points relating to what a project lead is responsible for are detailed in the "Guidelines for Participation." All prospective leads should read this document. For information on the political structure of OpenOffice.org, please read Community Council Charter.
There are three categories of public projects in OpenOffice.org: Accepted, Incubator, Native Language Confederation, also called "Native-Lang". "Accepted" here means that the project's code has been agreed upon by the community leaders to comprise the OpenOffice.org software product or that the project merits a significant voice in the running of OpenOffice.org.
The Native Language Confederation (NLC) is dedicated to providing information and support for OpenOffice.org community members in their native language. NLC does not replace the l10n (localization) or i18n (internationalization) efforts, which are jointly located within the l10n project website.
The Incubator category includes projects that are not yet fully mature (and may not wish to be). The Incubator category is governed by less strict rules. In a sense, it is a testing ground for ideas, an incubator, where the community can sponsor projects that may later make it into the "accepted" category.
As a result of this division of project types, it is expected that most but not all registered users will want to propose projects in the Incubator and Native-Lang categories, with the idea being that these spaces provide the room required for testing out projects and ideas. That said, interested registered users should look over all these protocols, and not just those pertaining to the category in which they are interested.
Proposing a Project: General Information
As mentioned above, only registered members may propose new projects. Besides that simple requirement, the member proposing the project must be known to the community as a reliable and trusted contributor to OpenOffice.org. She need not already be a developer or contributor, but she must be acknowledged by the community as possessing the necessary knowledge, skill, and maturity to see the project through. Essentially, we would like to avoid the creation of a graveyard of ill-managed projects and isolated developers.
From proposal to resolution, the process of proposing a project in the Incubator should take less than two weeks.
Procedural Steps
- Draft a short proposal (not more than 1/2 a page);
- Submit it to the Incubator lead, Louis Suarez-Potts for review;
- If it passes review, advertise that proposal on the relevant lists and on users@openoffice.apache.org; and
- After a few days (use your judgment), ask for a vote on the merits of the project. Give list members a several days to vote (again, use your judgment). The vote is an informal poll of support, a way of interesting the community; it is not meant to be a rigorous count. For this reason, a negative vote merits close attention and you should investigate the reasoning behind the vote.
- If you are successful in garnering support and people approve, go on to create the project.
The point of the community review process is to attract interest. If no one expresses interest or if people find problems with your proposal, you are free and encouraged to modify the proposal and try again.
If your proposal is accepted, then you need to contact the Incubator lead (in this case, Louis Suárez-Potts); he is the one who actually creates the project;
Promotion to Accepted Projects Category
Six months after initiation, an Incubator Category project lead may petition the Community Council to have his or her project promoted to "Accepted" status and be included in the "Public Projects" category. To start this process, send an e-mail to the Incubator Leads.
If the project is approved as an Accepted Project, it will be moved to that category. If not, it will remain in Incubator; this process can be repeated. To learn more about the political structure of OpenOffice.org, see the Community Council Charter.
Native Language Confederation (NLC) Projects
From proposal to resolution, the process of proposing a NLC project may take a week or so.
Procedural Steps
- Subscribe to the NLC mail list, dev@native-lang.openoffice.org. To subscribe, send a blank e-mail to dev-subscribe@native-lang.openoffice.org. Archives are available from the NLC homepage, http://native-lang.openoffice.org/.
- Draft a short proposal (not more than 1/2 a page) introducing you and your group and explaining the project in English. If you are working with l10n, or plan on doing so, mention this. Post this note to our dev@native-lang.openoffice.org mail list.
- We have to create the project for you.
Resolution
- NLC projects should be accepted at all times and without any particular condition, provided that:
- The project doesn't address a language already represented by a prior NLC project; and
- They agree to abide by the OpenOffice.org guidelines and policies.
After about a week, the project should be initiated, provided it meets with the obligations listed above. If nothing is happening, please remind us.
Setting Up the Project
These are the minimal guidelines that all new project leads should read over. They probably do not answer all your questions. For more information, ask on the relevant lists and do not hesitate to ask the Community Manager, Louis Suarez-Potts. A FAQ will evolve.
- First, safeguard your intellectual property. We urge all creators of Web content to use one of our licenses.
- For code, we ask that you fill out, sign, and submit the Sun Microsystems Inc. Contributor Agreement (SCA) (SCA) form. It grants rights jointly to Sun Microsystems and you.
- If you are only doing documentation and other non-code content, you can use the Public Documentation License (PDL), but it has to be attached to each document or referenced by linking (which is easier). You may also use the SCA, as for code. This assigns copyright jointly to Sun and you and material covered under it includes all works done by you contributed to the OpenOffice.org project except those works specifically covered by other licenses, such as the PDL.
- For material that is non-editable (PDFs, for instance), you can donate the work to the project (e.g., via the SCA) or make it public domain. You may also use the Creative Commons Attribution License ("Attribution NoDerivs 2.5"). Work submitted under this license is not editable. We want, however, editable work first and foremost.
- For more information, see our FAQ on licensing.
- We use SSH2, so you will need to create and send in an SSH2 key. Read over Tunneling with SSH2.
- We also use CVS, and there are several guides that explain how to use CVS both with a client and in command line mode. See, for starters, our Help on CVS. Each project also has specific help on the left navbar ("Version control") on how to use both CVS and anoncvs (for guest access). Note: your CVS password is the same as your OpenOffice.org user password.
- Create the Web pages, etc. you will use. The OpenOffice.org website is flexible and accepts all sorts of correctly formed HTML and CSS. However, it does not work directly with PHP, Wikis, Blogs, RSS. Our Style Guide details the general look desired for Web pages, as well as explaining how the site infrastructure works. The Help also explains how a Project Lead can customize the Web page. (Note: You must be logged in as a Project Lead to access this page.)
- Mail lists. Each new project is created with five (5) mail lists. These include discussion lists. We ask that you do not create new lists unless strictly necessary. Discussions, we have found, are more productive when conducted in fewer and more general lists.
- Granting members new roles. The process is not obvious. So, here is an explanation.
- Sponsors. If you wish to thank the sponsor of your project, go ahead; but ads for products are not generally permitted on the website.
- Issue Tracker (IssueZilla): It may be the case that the component associated with your project needs editing and you cannot do it. In that case, please contact Stefan Taxhet or Louis Suarez-Potts.
$Date: 2009/09/11 16:47:12 $ $Revision: 1.22 $