[prev in list] [next in list] [prev in thread] [next in thread]
List: pear-doc
Subject: [PEAR-DOC] cvs: peardoc /en/guide/developers contributing.xml
From: "Martin Jansen" <mj () php ! net>
Date: 2003-09-21 10:13:38
[Download RAW message or body]
mj Sun Sep 21 06:13:38 2003 EDT
Modified files:
/peardoc/en/guide/developers contributing.xml
Log:
* Updating contribution instructions to reflect the recent decision of
the PEAR Group.
* Removing instructions for rolling a release. Instead we now point users
to the release chapter, where the process is already described in detail.
Index: peardoc/en/guide/developers/contributing.xml
diff -u peardoc/en/guide/developers/contributing.xml:1.12 \
peardoc/en/guide/developers/contributing.xml:1.13
--- peardoc/en/guide/developers/contributing.xml:1.12 Sat Aug 30 03:25:57 2003
+++ peardoc/en/guide/developers/contributing.xml Sun Sep 21 06:13:38 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.12 $ -->
+<!-- $Revision: 1.13 $ -->
<!--
WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING
THIS DOCUMENT YET.
@@ -8,6 +8,16 @@
<title>Contributing your own code</title>
<titleabbrev>Contributing</titleabbrev>
+ <para>
+ PEAR is driven by a <ulink url="http://www.opensource.org/">open
+ source</ulink> oriented developer community. Thus there is a chance
+ for everybody to contribute code (in form of a new package or as an
+ improvement for an existing package) to the project. However PEAR
+ aims to keep the quality of the packages at a very high
+ level. Because of that there are certain requirements for
+ contributions, which are listed below.
+ </para>
+
<sect1 id="developers.contributing.requirements">
<title>Requirements for contributing code</title>
<titleabbrev>Requirements</titleabbrev>
@@ -200,16 +210,45 @@
Usually this announcement will spawn some discussion and the
developers will then start to vote for or against your proposal.
(You are of course urged to join the upcoming discussion.)
- Getting a +1 from a developer means she is in favour of your
- proposal, while getting a -1 means that the developer doesn't
- like it. If you finally have five +1's, you can go ahead
- with step 3.
</para>
+ <note>
+ <para>
+ The following passages are taken from the administrative
+ document <ulink
+ url="http://pear.php.net/group/docs/20030904-pph.php">Handling
+ Package Proposals</ulink>, which describes proposing new
+ packages in more details. Reading this document should be a
+ mandatory step for PEAR newbies.
+ </para>
+ </note>
+
+ <para>
+ Only the votes of active members of the PEAR community (must have
+ a PEAR web account, however the proposer himself is not counted)
+ are counted, however anyone may vote. Votes require that a final
+ choiceof package name is specified.
+ </para>
+ <para>
+ The votes are added up, which means that one -1 offsets a
+ +1. However -1 vote should always be considered to be serious and
+ may lead to decisions being made on a case by case basis by the
+ PEAR Group who reserves a veto (it is intended that in the future
+ the PEAR QA team will assist the PEAR Group in such
+ situations). Therefore a -1 vote *must* contain a comment
+ explaining that decision, it is desirable that votes in favour
+ (+1) should also be accompanied with an explanation when
+ appropriate.
+ </para>
+
+ <para>
+ A vote is accepted if the total of all votes exceeds +5.
+ </para>
+
<para>
- If you receive more than one -1 vote, this means there are serious issues
- with the proposal that should be fixed before a package is accepted, even
- if there are 5 +1's. Every proposal is unique, so conflicts regarding
- +1/-1 will be resolved by the PEAR Group.
+ In case the proposal is not accepted the package can be further
+ discussed on the list and the proposer may attempt to make
+ another "call for vote" (it is expected that this is only done
+ for sensible reasons).
</para>
</listitem>
@@ -229,7 +268,7 @@
<para>
This account is always necessary for you, if you want to release
your package through PEAR. With this account you have access
- to the necessary pages on
+ to the necessary functions on
<ulink url="&url.pear;">pear.php.net</ulink> in order
to upload and roll new releases.</para>
</listitem>
@@ -261,8 +300,8 @@
To sign up for your pear.php.net account, go to the
<ulink url="&url.pear.account.new;">PEAR account
request page</ulink> and fill out the form there. The PEAR
- administrators will then receive your request and they will open
- your account, if it sounds reasonable for them. You will be notified
+ Group will then receive your request and someone will open
+ your account, if the request sounds reasonable. You will be notified
about that via email. Please note that you do NOT need a pear.php.net
account to download packages from there.
</para>
@@ -289,35 +328,8 @@
</para>
<para>
After having registered your package, you can create a first
- release:
- </para>
- <para>
- The first prerequesite is to create a package definition file:
- This file is an XML file called <filename>package.xml</filename>
- that needs to reside in the root directory of your package.
- </para>
- <para>
- To learn about package definition files, please read
- <link linkend="developers.packagedef">here</link>.
- </para>
- <para>
- After having created this file, just run
- <screen>
- <userinput>
-$ pear package
- </userinput>
- </screen>
- in the directory that contains the package definition file.
- This command will create a <filename>.tgz</filename> file
- in the same directory. In our example, the complete filename
- would be <filename>Money_Fast-1.0.tgz</filename>.
- </para>
- <para>
- Now go to
- <ulink url="&url.pear.package.upload;">this page</ulink>
- and upload the tgz file that has been created previously there.
- This will start the automated release process, which will roll
- out version 1.0 of the package Money_Fast.
+ release, which is described <link
+ linkend="developers.release">here</link>.
</para>
</listitem>
</orderedlist>
--
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic