On Sun, Apr 22, 2001 at 11:52:12AM +0200, Johan Vromans wrote:
> Personally, I'd like to impose these to any CPAN submission
> whatsoever...
Let's not dig into that 55-gallon drum of man-eating nightcrawlers
here, K?
As for below, I'd do this as a two-stage process. First, let's all
agree that nothing gets in without some sort of docs and tests. We'll
work on the things discussed below after.
> For modules to be part of the core the requirements can be (and
> should be) much higher. At least:
> - have a clear maintenance status (who is maintaining?
> responsiveness?)
Yes. This is more of an ongoing thing, though. Initially, the module
will be maintained at the very least by the guy who proposed including
it into the core. Later on it may fall out of use and we'll have to
watch for that.
Things like h2ph and h2xs are probably good examples of lost children.
> - have decent documentation, extensive if it is a complex module.
Problem is the definition of "decent". I can work better by
counter-example. Here's a smattering of core modules which do not
have "decent" docs...
B - lots of undocumented or barely documented methods and functions
missing obvious references to things like perlxs, perlxstut,
perlhack, etc..
warnings::register - only has a name, almost no docs at all. The 'warnings'
man page mentions it in passing.
XSLoader - "This module defines a standard simplified interface..."
however, that interface is almost totally undocumented.
Test - skip() and todo() are almost undocumented. ok() is only documented
via examples.
DB - marginal. Missing docs on several CLIENT methods and public global
variables. With such a large interface its easy to miss a few and
I'd recommend "inline" POD for such a module.
I think a "meta-rule" could be derived from this. Modules with big
interfaces (such as B and DB) should use inline POD for easier
maintenance and spotting of undocumented functions.
> - (maybe) standards on version numbers?
I'll be happy if it has some sort of $VERSION at all.
The problem with trying to standardize the actual number is what
happens with things that have dual lives on CPAN? Does the version
number suddenly change? That wouldn't seem right.
--
Michael G. Schwern <[EMAIL PROTECTED]> http://www.pobox.com/~schwern/
Perl6 Quality Assurance <[EMAIL PROTECTED]> Kwalitee Is Job One
You see, in this world there's two kinds of people. Those with loaded
guns, and those who dig. Dig.
-- Blonde, "The Good, The Bad And The Ugly"
