Re: Contributing new package
| From: | David Sanders | Date: | Tue, 31 Jul 2007 03:42:06 +0000 |
| Subject: | Re: Contributing new package | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-47721@lists.php.net to get a copy of this message | ||
christ1an wrote:
I am very interested in contributing a new package to PEAR. You can find a description of the project on http://php-ids.org/ Would someone be willing to mentor me through the PEPr proposal process?Hi Christian, Seeing as nobody's replied to this yet, I thought I'd say something... I don't really have the time to mentor anyone at the moment and I've only briefly read the description of your project but I can give you a couple of pointers off the top of my head: 1. Choose an appropriate category for your package. 2. Choose a name for your package, if the category you chose was HTML, then the name of your package will be prefixed with HTML_ 3. Convert your project into a PEAR package: - Rename your classes appropriately - Create a specialised exception extending the PEAR_Exception and use them - Create phpdoc comments for all files, classes, methods and properties - Ensure it follows the PEAR coding standards - Create a package.xml file - Create an installable tgz out of the package.xml and have it somewhere publicly available 4. Create an area to view the source online through any means. Eg through web based version control client, or phps files. 5. Create a new proposal and describe why the package would be a useful addition to PEAR and why people would want to download your package. Add links to the installable package and the viewable online source files. 6. When you're ready for the PEAR community to examine the package, you set the proposal to "Comments" 7. People may/may not ask questions and comment on the proposal. 8. After 1 week you can call the proposal to votes. It requires 5 votes in total to be accepted. If accepted then you can go on to the steps to add the package to PEAR. Anyway all of this information is available in the PEAR Manual if you'd like to further clarify anything. http://pear.php.net/manual/en/ -- David Sanders shangxiao