PHP PEAR Questions and Answers - Re: [PEAR-QA] Re: [Fwd: cvs: pear /PHP_CompatInfo/docs/examples ci

Author

Re: [PEAR-QA] Re: [Fwd: cvs: pear /PHP_CompatInfo/docs/examples ci_frontend.php]

Stefano F. Rausch

2006-06-17, 8:09 am

Hi ...

I did have the understanding that for stable packages a documentation (as well as regression/unit tests) is a mandatory prerequisite, even if it's only a .txt file. Have things changed in this respect? Have the rules been "relaxed"?

I'm looking forward to receiving your comments at your earliest convenience.

Best regards

-- Stefano

Pierre wrote:[color=darkred]
> On Sat, 10 Jun 2006 19:13:12 +0200
> pear@laurent-laville.org (Laurent Laville) wrote:
>
>
> Yes, obviously :)
>
> -- Pierre
>

Stefano F. Rausch

2006-06-17, 8:09 am

Thanks for the clarification Pierre.

@ Lukas:

> I wasnt aware of such regulations. AFAIK we just require API documentation and a sort of unwritten rule is some form of end user documentation, where some examples are however considered to be sufficient.

There are some rules, which are not written down, but are "gentlemen's agreement" within the PEAR community - as you're stating it. My understanding was, that a guide/manual in at least .txt format is more than welcomed.

So I'm fine with the current situation, I just wanted the status quo to be clarified.

Thanks again to all.

-- Stefano

Pierre wrote:
> On 6/11/06, Stefano F. Rausch <stefano@rausch-e.net> wrote:
>
> No, but packages released as stable before the enforcement of these
> rules can obviously still be released.
>
> In the case of Compatinfo, there is tests, docs and examples in the
> package itself.
>
> --Pierre
>

Sponsored Links