Contributing FAQ, Questions

This is my first contribution to PEAR, and it's probably best I do it in such a way that limits the amount of changes anyone needs to inform me of before I put my proposal in. I've searched but been unable to find a doc that lies out, step by step, with examples, of how to build a library in the PEAR way and prepare it for scrutiny. I've gone through this doc: http://pear.php.net/manual/en/developers.contributing.php Here's what I've done:

    1. Reviewed coding standards, wrote the library following them.
    2. Released the code under the GNU GPL (due to the fact that this is a
       derivative work of GPL'ed code)
    3. Posted in Google Code.
    4. Written as a class to be extensible.
    5. Generated documentation based on the code written according to the
       above standards.
    6. Wrote regression tests with PHPUnit.
    7. Am willing to support the package.

Additionally I've written my package.xml file. The only point I'm having trouble with is the documentation and how it fits into my "package" from a directory structure standpoint. I've worked with DocBook before, but am unsure how the documentation needs to be laid out in the directory structure to make sure the system auto-generates the docBook HTML gunk on the pear site. I used the suggested converter with success, but would like some more information about how exactly I need to lay the docs out. Also, for packages in a specific category, would the CVS directory structure look like this:

    /package.xml
    /Numbers
    /Numbers/PackageName.php
    /Numbers/test.php
    /docs

or

    /package.xml
    /PackageName.php
    /test.php
    /docs

I haven't been able to find that kind of specific info in the Manual. Once I've gone through the process, I may write up an example-specific step-by-step how to write your code and get it ready for insertion into PEAR (assuming your code proposal will be/is approved) and add that to peardoc. Beckman ---------------------------------------------------------------------------

Peter Beckman                                                  Internet Guy
beckman@purplecow.com                             http://www.purplecow.com/

---------------------------------------------------------------------------