cvs: peardoc /en/guide/developers contributing.xml

mj Sun Mar 14 14:33:35 2004 EDT Modified files: /peardoc/en/guide/developers contributing.xml Log: * Typo fixes http://cvs.php.net/diff.php/peardoc/en/guide/developers/contributing.xml?r1=1.17&r2=1.18&ty=u Index: peardoc/en/guide/developers/contributing.xml diff -u peardoc/en/guide/developers/contributing.xml:1.17 peardoc/en/guide/developers/contributing.xml:1.18 --- peardoc/en/guide/developers/contributing.xml:1.17 Sun Jan 25 06:17:09 2004 +++ peardoc/en/guide/developers/contributing.xml Sun Mar 14 14:33:35 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.17 $ --> +<!-- $Revision: 1.18 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -9,7 +9,7 @@ <titleabbrev>Contributing</titleabbrev> <para> - PEAR is driven by a <ulink url="http://www.opensource.org/">open + PEAR is driven by an <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 @@ -23,22 +23,22 @@ <titleabbrev>Requirements</titleabbrev> <simpara> - There are certain requirements both for the code and for the author of a - package in PEAR: + We are making certain demands on both the code and the maintainers + of packages: </simpara> <para> <orderedlist> <listitem> <simpara> - Conforming to the coding standards. + Code must be conforming to the Coding Standards. </simpara> <para> If you want to contribute your code to PEAR in form of a new package or as an addition to an existing package, it has to be - compliant to a set of <link linkend="standards">coding - standards</link>. There have been numerous discussions about - whether the coding standards are good or not and the decision has + compliant to a set of <link linkend="standards">Coding + Standards</link>. There have been numerous discussions about + whether those standards are good or not and the decision has been made that they are absolutely necessary. There is no sense in discussing about this. </para> @@ -50,22 +50,23 @@ </simpara> <para> Always keep in mind that your code should be extensible and that - it has to be easy to add new features in the future. If there is no - easy way to extend the functionality of your code without breaking backwards - compatibility with existing code, you should consider implementing a - better design before proposing the package for inclusion in PEAR. + it has to be easy to add new features in the future. If it is + easily predictable for you that there is no clean way to add new + functionality to the codebase without breaking backwards + compatibility, you should consider to review the code and to + adapt it, <emphasis>before</emphasis> contributing it to PEAR. </para> <para> - It may be helpful in this context to become familiar with the - basic of object oriented programming. Eventhough PHP does not + In this context it may be helpful to become familiar with the + basics of object oriented programming. Eventhough PHP 4 does not come with full object oriented support yet, the knowledge will - possibly help you in maintaining a extensible state for your + possibly help you in maintaining an extensible state for your package code. There are numerous resources about object oriented programming all around the web and you will also find tons of books available for your reading pleasure. However we can can recommend <ulink url="&url.java.oo;">Object-Oriented Programming - Concepts</ulink> over there on <ulink url="&url.java;">Sun's Java - Homepage</ulink>. + Concepts</ulink> on <ulink url="&url.java;">Sun's Java + Homepage</ulink> for a quick start. </para> </listitem> @@ -100,13 +101,13 @@ <para> As of August 2003, <ulink url="&url.phpdocumentor;">phpDocumentor</ulink> is fully capable of converting in-code API documentation and external - tutorials into XML DocBook for use with PEAR. - PhpDocumentor version 1.2.2 or greater is required. Install with - <literal>pear install phpDocumentor</literal>. Use the - XML:DocBook/peardoc2:default converter on your source code to generate - output. The output should be generated directly into the - <literal>peardoc/lang/package</literal> directory, where lang is en, - or fr, etc. + tutorials into Docbook XML. PhpDocumentor version 1.2.2 or + greater is required. Install with <literal>pear install + phpDocumentor</literal>. Use the XML:DocBook/peardoc2:default + converter on your source code to generate output. The output + should be generated directly into the + <literal>peardoc/lang/package</literal> directory, where lang is + en, or fr, etc. </para> <para> Be aware though that only shipping the API documentation does