Text-Tradition

Kwalitee Fails

Core metrics

These fails do affect your Kwalitee scores. This distribution may not be installed cleanly, or may have some issues in license or documentation. Please consider fixing them, or tell us if they are false.

metricremedy
extracts nicely

This distribution doesn't create a directory and extracts its content into this directory. Instead, it creates more than one directories (some of which are probably system-specific hidden files/directories), or it spews its content into the current directory, making it really hard/annoying to remove the unpacked package.

Pack the distribution with a proper command such as "make dist" and "./Build dist", or use a distribution builder such as Dist::Zilla, Dist::Milla, Minilla.

has readme

The file "README" is missing from this distribution. The README provides some basic information to users prior to downloading and unpacking the distribution.

Add a README to the distribution. It should contain a quick description of your module and how to install it.

has proper version

The version number isn't a number. It probably contains letter besides a leading 'v', which it shouldn't

Remove all letters from the version number. If you want to mark a release as a developer release, use the scheme 'Module-1.00_01'

no generated files

This distribution has files/directories that should be generated at build time, not distributed by the author.

Remove the offending files/directories!

no mymeta files

This distribution contains MYMETA.* files which should be used only locally. This metric should be integrated into 'no_generated_files' eventually, but as MYMETA.* files are recent inventions, you might need to take special care if MANIFEST.SKIP exists in your distribution. Hence this metric.

Update MANIFEST.SKIP to exclude MYMETA files. If you are lazy, add "#!install_default" in your MANIFEST.SKIP and update your ExtUtils::Manifest if necessary, then some of the most common files will be excluded.

no broken module install

This distribution uses an obsolete version of Module::Install. Versions of Module::Install prior to 0.61 might not work on some systems at all. Additionally if your Makefile.PL uses the 'auto_install()' feature, you need at least version 0.64. Also, 1.04 is known to be broken.

Upgrade the bundled version of Module::Install to the most current release. Alternatively, you can switch to another build system / installer that does not suffer from this problem. (ExtUtils::MakeMaker, Module::Build both of which have their own set of problems.)

manifest matches dist

MANIFEST does not match the contents of this distribution.

Run a proper command ("make manifest" or "./Build manifest", maybe with a force option), or use a distribution builder to generate the MANIFEST. Or update MANIFEST manually.

package version matches dist version

None of the package versions in this distribution matches the distribution version.

Fix the version(s).

Extra metrics

These fails affect your total Kwalitee score, but don't affect the one for the Game. Some of them should be fixed by all means. Others are just matters of taste.

metricremedy
is prereq

This distribution is not required by another distribution by another author.

Convince / force / bribe another CPAN author to use this distribution.

Experimental metrics

These fails are not serious and don't affect your Kwalitee scores at all.

metricremedy
meta yml has provides

This distribution does not have a list of provided modules defined in META.yml.

Add all modules contained in this distribution to the META.yml field 'provides'. Module::Build or Dist::Zilla::Plugin::MetaProvides do this automatically for you.

meta yml has repository resource

This distribution does not have a link to a repository in META.yml.

Add a 'repository' resource to the META.yml via 'meta_add' accessor (for Module::Build) or META_ADD parameter (for ExtUtils::MakeMaker).

has separate license file

This distribution does not have a LICENSE or LICENCE file in its root directory.

This is not a critical issue. Currently mainly informative for the CPANTS authors. It might be removed later.

History