Re: hope to finish the coding standard
| From: | Alan Knowles | Date: | Fri, 21 Dec 2001 06:53:17 +0000 |
| Subject: | Re: hope to finish the coding standard | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-3631@lists.php.net to get a copy of this message | ||
How about this as an addition to the faq?
trouble is the emphasis of the coding standard tends to overkill the softer message that 'heh were open to contributions' - give it to us....
Perhaps a Link on the front page of pear.php.net under faq
contributing to PEAR .....
regards
alan
Index: pearfaq.xml
===================================================================
RCS file: /repository/pearweb/doc/pearfaq.xml,v
retrieving revision 1.34
diff -u -r1.34 pearfaq.xml
--- pearfaq.xml 15 Dec 2001 17:38:59 -0000 1.34 +++ pearfaq.xml 21 Dec 2001 06:34:40 -0000@@ -460,6 +460,62 @@ </qandaentry> </qandaset> + + <qandaentry> + <question title="I have written a php class as part of another project - can I contribute it?" />
+ <answer> + <author name="Alan Knowles"/> + <para> + Sure, We welcome contributions, however you should consider the following questions + + <simplelist> + <member> + Is it usefull for others + </member> + <member> + Is there already a class that does something similar, does yours improve or replace that one. + </member> + <member> + Look at the Top level naming structure for Naming Classes in PEAR, and think what the + best name for your class should be (obviously if it doesnt match yours, you can use a wrapper/extension + class to keep backward compatibility to your own applications.) + </member> + <member> + Send a message describing your class to the mailing list, - be polite, and a little persistant, + remember everybody is a volunteer, and be prepared to send anyone a copy of you code to + look at. + </member> + </simplelist> + + If your code does not use the <ulink + url="http://php.net/manual/pear.standards.php">PEAR Coding + Standards</ulink>, you should also consider these issues. + <simplelist> + <member> + At some point you (or another volunteer) may change all the formating and method names + to match the <ulink + url="http://php.net/manual/pear.standards.php">PEAR Coding + Standards</ulink> + </member> + <member> + You should be responsible for creating and maintaining a Backward Compatible wrapper + class (if you consider it neccessary). For example if you are using underscore_methods + rather than StudlyCaps. + </member> + <member> + Until your code is compatible with the PEAR Coding Standards it should be marked as alpha + </member> + + </simplelist> + </para> + <para> + See also <ulink url="http://www.php.net/cvs-php.php">Using + CVS for PHP Development</ulink>. + </para> + </answer>+ </qandaentry> + + </article> <!-- Keep this comment at the end of the file