cvs: peardoc /en/guide/newmaint proposal.xml

mj Sat Apr 24 09:01:08 2004 EDT Modified files: /peardoc/en/guide/newmaint proposal.xml Log: * Pushing the New Maintainers' Guide to a releaseable state. http://cvs.php.net/diff.php/peardoc/en/guide/newmaint/proposal.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/guide/newmaint/proposal.xml diff -u peardoc/en/guide/newmaint/proposal.xml:1.1 peardoc/en/guide/newmaint/proposal.xml:1.2 --- peardoc/en/guide/newmaint/proposal.xml:1.1 Sat Mar 27 04:15:12 2004 +++ peardoc/en/guide/newmaint/proposal.xml Sat Apr 24 09:01:08 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <chapter id="newmaint.proposal"> <docinfo> <author> @@ -10,7 +10,7 @@ <firstname>Tobias</firstname> <surname>Schlitt</surname> </author> - <date>$Date: 2004/03/27 09:15:12 $</date> + <date>$Date: 2004/04/24 13:01:08 $</date> </docinfo> <title>The formal proposition process</title> <titleabbrev>Proposing</titleabbrev> @@ -44,7 +44,8 @@ <sect1 id="newmaint.proposal.requirements"> - <title>Requirements for a proposal</title> + <title>Step 1: Requirements for a proposal</title> + <titleabbrev>Step 1</titleabbrev> <simpara> The following enumeration lists the most important things that need @@ -63,6 +64,11 @@ browse the <ulink url="&url.pear.package.browse;">list of existing packages</ulink>. </simpara> + <simpara> + Choosing a name for the package is an iterative process and it is + likely that you will change the name at later of the proposal + process. + </simpara> </listitem> <listitem> <simpara> @@ -78,16 +84,34 @@ <simpara> Writing a package description </simpara> + <simpara> + For starting the proposal you will need to write a description of + the package. This description does not need to mention every + detail of the package, but it should at least outline the basic + concept and feature set. When your package has been accepted, you + will have to come up with a single-line summary and a fulltext + description. + </simpara> </listitem> <listitem> <simpara> - Choosing a licence for the package + Choosing a license for the package + </simpara> + <simpara> + Each package has to be licensed under a accepted OpenSource + license. If you are unsure about the license, you should opt for + the <ulink url="&url.license.php;">PHP License</ulink>. </simpara> </listitem> <listitem> <simpara> Writing examples and documentation </simpara> + <simpara> + Without proper usage examples and documentation, neither will the + PEAR developers be able to evaluate your package nor will users be + able to make use of your package. + </simpara> </listitem> <listitem> <simpara> @@ -97,15 +121,15 @@ </itemizedlist> </sect1> - <sect1 id="newmaint.proposal.step2"> <title>Step 2: Initiating a discussion</title> <titleabbrev>Step 2</titleabbrev> <simpara> Before starting the proposal process in PEPr, a thread should be - started for each new package on the developers mailing list. We are - preferring this intermediate step for the sake of convenience, + started for each new package on the <ulink + url="mailto:&email.pear.dev;">developers mailing list</ulink>. We + are preferring this intermediate step for the sake of convenience, because we feel that it is easier and more comfortable for us to hit a single key in our mail client to join a discussion, than to open a browser window and looking for the right page on the website. @@ -152,7 +176,7 @@ different cultural backgrounds. Because of that most people in the community are not native english speakers; do not worry if your English is not perfect and, most importantly, be aware that - sometimes misunderstandings may happen. So it is important that + sometimes misunderstandings may happen. It is important that everybody involved tries to be as clear as possible. </simpara> @@ -169,26 +193,26 @@ <titleabbrev>Step 3</titleabbrev> <para> - The way to handle proposals inside the community has been automated - in 2003 to ensure the quality of the packages even before a package - is proposed and to take away some work from the active package - maintainers. To be able to use the proposal tool (<ulink - url="&url.pear.pepr;">PEPr</ulink>), you have to apply to a PEAR - website account <ulink url="&url.pear.account.new;">here</ulink>. - After that you can open a new proposal using the - "<ulink url="http://pear.php.net/pepr/pepr-proposal-edit.php">New - package proposal</ulink>" link on your left. + To be able to use the proposal tool (<ulink + url="&url.pear.pepr;">PEPr</ulink>), you have <ulink + url="&url.pear.account.new;">to apply for a PEAR website + account</ulink>. This account will usually be granted within one or + two days. After that you can open a new proposal using the + <quote><ulink url="&url.pear.pepr.edit;">New package + proposal</ulink></quote> link on your left. </para> <para> - The process of a package proposal is divided into 4 stages: "Draft", - "Proposal", "Call for Votes" and "Finished". Every proposal has to - run through all of these stages. Inside each stage (except the draft + The process of a package proposal is divided into 4 stages: + <quote>Draft</quote>, <quote>Proposal</quote>, <quote>Call for + Votes</quote> and <quote>Finished</quote>. Every proposal has to run + through all of these stages. During each stage (except for the draft stage) an email is send to you (the proposer) and the PEAR - development mailinglist (<ulink + developer mailinglist (<ulink url="mailto:&email.pear.dev;">&email.pear.dev;</ulink>) for any action. A good idea is to <ulink - url="&url.pear.support;">subscribe</ulink> to this mailinglist to - get a better picture of what the community process is like. + url="mailto:&email.pear.dev-subscribe;">subscribe</ulink> to this + mailinglist to get a better picture of what the community process is + like. </para> <para> <orderedlist>