Re: Coding / Package guides
| From: | Tomas V.V.Cox | Date: | Sat, 27 Oct 2001 01:55:16 +0000 |
| Subject: | Re: Coding / Package guides | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-2399@lists.php.net to get a copy of this message | ||
Ulf Wendel wrote:
>
> Hi,
>
> two questions the FAQ could not answer:
>
> Am I expected to add examples and/or test files to my package?
Not really, but to privide them will help you to ensure that the changes
you introduce in the future don't break the app and also will help
people to understand better how your class work as they get working
examples code. BTW There is a test suite for PHP that is being used also
for PEAR.
The directory where tests files should located is:
<package-dir>/
|
+-tests/
> Where should my example files go?
There is no convention yet for where to put documentation or examples
for packages. I proposed time ago the following structure:
<package-dir>/
|
+-docs/
|
+-apidoc/
+-examples/
Tomas V.V.Cox