Re: Net_SmartIRC first package.xml

Mirco Meebey Bauer wrote:

How does this package looks like? <?xml version="1.0" encoding="ISO-8859-1" ?> <!DOCTYPE package SYSTEM "../package.dtd"> <package version="1.0"> <name>Net_SmartIRC</name> <summary>Net_SmartIRC is a PHP class for communication with IRC networks</summary> <description> Net_SmartIRC is a PHP class for communication with IRC networks, which conforms to the RFC 2812 (IRC protocol). It's an API that handles all IRC protocol messages. This class is designed for creating IRC bots, chats and show irc related info on webpages. </description> <license>LGPL</license> <maintainers>

    <maintainer>
      <user>meebey</user>
      <role>lead</role>
      <name>Mirco Bauer</name>
      <email>mail@meebey.net</email>
    </maintainer>

</maintainers> <release>

    <version>0.4.1</version>
    <state>beta</state>
    <date>2002-12-13</date>
    <notes>

This is the first release in PEAR, this project is former known as phpSmartIRCclass (beta because of first release in PEAR, the project itself is stable)

    </notes>
    <filelist>
      <file role="php" baseinstalldir="/Net">SmartIRC.inc.php</file>

Shouldn't this file be named SmartIRC.php to conform with PEAR standards (without the .inc).

      <dir name="SmartIRC">
        <file role="php">defines.inc.php</file>

Same here...

        <file role="php">example.php</file>
        <file role="php">example2.php</file>
        <file role="doc">CHANGELOG</file>
        <file role="doc">CREDITS</file>
        <file role="doc">DOCUMENTATION</file>
        <file role="doc">README</file>
        <file role="doc">HOWTO</file>
    </dir>
    </filelist>

</release> </package> Mirco Bauer aka MEEBEY

Other code comments and ramblings: Also, imho it is wise to first let a package reside on cvs for a while, before actually packaging it, so that you'll be able to do quick bug fixes/code changes without having to re-release a new package each time. You might want to change the license before commiting to cvs (you agreed to change to LGPL or PHP right?). I'm thinking, what's the policy on include files? As your defines.inc.php does nothing but define constants, why a include file at all, why not just put them in the main file. As I remember, the DB package also has quite a bit of constants, and they are all defined in the DB.php file. Having a long constant declaration list in your main file isn't bad thing imho. Are the benchmark*() methods really needed in your class, because they have little to do with the whole IRC thing. You might want to change you method naming some more, to conform with the PEAR coding standards (http://pear.php.net/manual/en/standards.naming.php). Functions and methods should have 'studly caps'. So, for example, setlogfile() would become setLogfile(), and senddelay() sendDelay(). Otherwise, this could make for a very useful class in PEAR. Oh, yeah, I'm in favor of a release as NET_IRC 2.0. cheers, Stijn de Reede