What's "Kwalitee"?
"Kwalitee" is something that looks like quality, sounds like quality, but is not quite quality.
Kwalitee indicators
We have 26 Kwalitee indicators, and 8 optional indicators as well.
| Name | Description | Remedy | Fail (Latest) | Fail (CPAN) | Fail (BackPAN) |
|---|---|---|---|---|---|
| extractable | This distribution doesn't extract well due to several reasons such as unsupported archive type (CPANTS only supports tar.gz, tgz and zip archives), file permissions, invalid filenames, and so on. Most of other kwalitee metrics should be ignored. (defined in Module::CPANTS::Kwalitee::Files) |
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. You might also need to set some options or environmental variables to ensure your archiver work portably. | 50 (0.18 %) |
193 (0.21 %) |
668 (0.34 %) |
| extracts nicely | This distribution doesn't create a directory and extracts its content into this directory. Instead, it spews its content into the current directory, making it really hard/annoying to remove the unpacked package. (defined in Module::CPANTS::Kwalitee::Files) |
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. | 876 (3.23 %) |
2601 (2.86 %) |
6838 (3.44 %) |
| 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. (defined in Module::CPANTS::Kwalitee::Files) |
Add a README to the distribution. It should contain a quick description of your module and how to install it. | 2244 (8.27 %) |
7759 (8.53 %) |
16668 (8.38 %) |
| has manifest | The file "MANIFEST" is missing from this distribution. The MANIFEST lists all files included in the distribution. (defined in Module::CPANTS::Kwalitee::Files) |
Add a MANIFEST to the distribution. Your buildtool should be able to autogenerate it (eg "make manifest" or "./Build manifest") | 721 (2.66 %) |
2037 (2.24 %) |
4980 (2.50 %) |
| has meta yml | The file "META.yml" is missing from this distribution. META.yml is needed by people maintaining module collections (like CPAN), for people writing installation tools, or just people who want to know some stuff about a distribution before downloading it. (defined in Module::CPANTS::Kwalitee::Files) |
Add a META.yml to the distribution. Your buildtool should be able to autogenerate it. | 4907 (18.08 %) |
15697 (17.26 %) |
43275 (21.75 %) |
| has buildtool | Makefile.PL and/or Build.PL are missing. This makes installing this distribution hard for humans and impossible for automated tools like CPAN/CPANPLUS/cpanminus. (defined in Module::CPANTS::Kwalitee::Files) |
Add a Makefile.PL (for ExtUtils::MakeMaker/Module::Install) or a Build.PL (for Module::Build and its friends), or use a distribution builder such as Dist::Zilla, Dist::Milla, Minilla. | 241 (0.89 %) |
717 (0.79 %) |
2247 (1.13 %) |
| has changelog | The distribution hasn't got a Changelog (named something like m/^chang(es?|log)|history$/i. A Changelog helps people decide if they want to upgrade to a new version. (defined in Module::CPANTS::Kwalitee::Files) |
Add a Changelog (best named 'Changes') to the distribution. It should list at least major changes implemented in newer versions. | 2991 (11.02 %) |
8219 (9.04 %) |
18122 (9.11 %) |
| no symlinks | This distribution includes symbolic links (symlinks). This is bad, because there are operating systems that do not handle symlinks. (defined in Module::CPANTS::Kwalitee::Files) |
Remove the symlinks from the distribution. | 31 (0.11 %) |
113 (0.12 %) |
214 (0.11 %) |
| has tests | This distribution doesn't contain either a file called 'test.pl' or a directory called 't'. This indicates that it doesn't contain even the most basic test-suite. This is really BAD! (defined in Module::CPANTS::Kwalitee::Files) |
Add tests! | 1479 (5.45 %) |
3903 (4.29 %) |
9336 (4.69 %) |
| buildtool not executable | The build tool (Build.PL/Makefile.PL) is executable. This is bad because you should specify which perl you want to use while installing. (defined in Module::CPANTS::Kwalitee::Files) |
Change the permissions of Build.PL/Makefile.PL to not-executable. | 1569 (5.78 %) |
5855 (6.44 %) |
15547 (7.82 %) |
| no generated files | This distribution has files/directories that should be generated at build time, not distributed by the author. (defined in Module::CPANTS::Kwalitee::Files) |
Remove the offending files/directories! | 238 (0.88 %) |
785 (0.86 %) |
1855 (0.93 %) |
| non portable filenames | This distribution has at least one file with non-portable characters in its filename, which may cause problems under some environments. (defined in Module::CPANTS::Kwalitee::Files) |
Rename those files with alphanumerical characters, or maybe remove them because in many cases they are automatically generated for local installation. | 58 (0.21 %) |
240 (0.26 %) |
803 (0.40 %) |
| no dot underscore files | This distribution has dot underscore files which may cause various problems. (defined in Module::CPANTS::Kwalitee::Files) |
If you use Mac OS X, set COPYFILE_DISABLE (for OS 10.5 and better) or COPY_EXTENDED_ATTRIBUTES_DISABLE (for OS 10.4) environmental variable to true to exclude dot underscore files from a distribution. | 85 (0.31 %) |
288 (0.32 %) |
775 (0.39 %) |
| has version | The distribution filename (eg. Foo-Bar-1.42.tar.gz) does not include a version number (or something that looks like a reasonable version number to CPAN::DistnameInfo) (defined in Module::CPANTS::Kwalitee::Distname) |
Add a version number to the packed distribution. Or use a buildtool ('make dist' or 'Build dist') | 2 (0.01 %) |
126 (0.14 %) |
459 (0.23 %) |
| has proper version | The version number isn't a number. It probably contains letter besides a leading 'v', which it shouldn't (defined in Module::CPANTS::Kwalitee::Distname) |
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' | 144 (0.53 %) |
775 (0.85 %) |
2399 (1.21 %) |
| metayml is parsable | The META.yml file of this distribution could not be parsed by the version of CPAN::Meta::YAML.pm CPANTS is using. (defined in Module::CPANTS::Kwalitee::MetaYML) |
If you don't have one, add a META.yml file. Else, upgrade your YAML generator so it produces valid YAML. | 5091 (18.76 %) |
16367 (17.99 %) |
45018 (22.63 %) |
| metayml has license | This distribution does not have a license defined in META.yml. (defined in Module::CPANTS::Kwalitee::MetaYML) |
Define the license if you are using in Build.PL. If you are using MakeMaker (Makefile.PL) you should upgrade to ExtUtils::MakeMaker version 6.31. | 11897 (43.84 %) |
38013 (41.79 %) |
93192 (46.85 %) |
| metayml conforms to known spec | META.yml does not conform to any recognised META.yml Spec. (defined in Module::CPANTS::Kwalitee::MetaYML) |
Take a look at the META.yml Spec at http://module-build.sourceforge.net/META-spec-current.html and change your META.yml accordingly. | 11140 (41.05 %) |
37032 (40.71 %) |
94815 (47.66 %) |
| proper libs | There is more than one .pm file in the base dir, or the .pm files are not in lib/ directory. (defined in Module::CPANTS::Kwalitee::FindModules) |
Move your *.pm files in a directory named 'lib'. The directory structure should look like 'lib/Your/Module.pm' for a module named 'Your::Module'. | 770 (2.84 %) |
2831 (3.11 %) |
7816 (3.93 %) |
| no pod errors | The documentation for this distribution contains syntactic errors in its POD. Note that this metric tests all .pl, .pm and .pod files, even if they are in t/. See 'pod_message' in the dist error view for more info. (defined in Module::CPANTS::SiteKwalitee::Pod) |
Remove the POD errors. You can check for POD errors automatically by including Test::Pod to your test suite. | 2113 (7.79 %) |
9095 (10.00 %) |
23508 (11.82 %) |
| has working buildtool | 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. (defined in Module::CPANTS::Kwalitee::BrokenInstaller) |
Upgrade the bundled version of Module::Install to at least 0.61, but preferably 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.) | 250 (0.92 %) |
948 (1.04 %) |
3013 (1.51 %) |
| has better auto install | This distribution uses an old version of Module::Install. Versions of Module::Install prior to 0.89 does not detect correcty that CPAN/CPANPLUS shell is used. (defined in Module::CPANTS::Kwalitee::BrokenInstaller) |
Upgrade the bundled version of Module::Install to at least 0.89, but preferably 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.) | 460 (1.69 %) |
1889 (2.08 %) |
4887 (2.46 %) |
| has humanreadable license | This distribution does not have a license defined in the documentation or in a file called LICENSE (defined in Module::CPANTS::Kwalitee::License) |
Add a section called "LICENSE" to the documentation, or add a file named LICENSE to the distribution. | 7888 (29.06 %) |
26086 (28.68 %) |
64973 (32.66 %) |
| valid signature | This dist failed its Module::Signature verification and does not to install automatically through the CPAN client if Module::Signature is installed. Note: unsigned dists will automatically pass this kwalitee check. (defined in Module::CPANTS::SiteKwalitee::Signature) |
Sign the dist as the last step before creating the archive. Take care not to modify/regenerate dist meta files or the manifest. | 93 (0.34 %) |
383 (0.42 %) |
878 (0.44 %) |
| use strict | This distribution does not 'use strict;' in all of its modules. (defined in Module::CPANTS::Kwalitee::Uses) |
Add 'use strict' to all modules. | 3131 (11.54 %) |
13603 (14.95 %) |
33636 (16.91 %) |
| manifest matches dist | MANIFEST does not match the contents of this distribution. (defined in Module::CPANTS::Kwalitee::Manifest) |
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. | 2460 (9.06 %) |
8106 (8.91 %) |
18244 (9.17 %) |
| Name | Description | Remedy | Fail (Latest) | Fail (CPAN) | Fail (BackPAN) |
|---|---|---|---|---|---|
| has tests in t dir | This distribution contains either a file called 'test.pl' (the old test file) or is missing a directory called 't'. This indicates that it uses the old test mechanism or it has no test-suite. (defined in Module::CPANTS::Kwalitee::Files) |
Add tests or move tests.pl to the t/ directory! | 3674 (13.54 %) |
10672 (11.73 %) |
25428 (12.78 %) |
| has example | This distribution does not include examples. (defined in Module::CPANTS::Kwalitee::Files) |
Add a directory matching the regex (bin|scripts?|ex|eg|examples?|samples?|demos?) or a file matching the regex /\/(examples?|samples?|demos?)\.p(m|od)$/i to your distribution that includes some scripts showing one or more use-cases of the distribution. | 19957 (73.53 %) |
62779 (69.02 %) |
132015 (66.37 %) |
| no stdin for prompting | This distribution is using direct call from STDIN instead of prompt(). Make sure STDIN is not used in Makefile.PL or Build.PL. See http://www.perlfoundation.org/perl5/index.cgi?cpan_packaging (defined in Module::CPANTS::Kwalitee::Files) |
Use the prompt() method from ExtUtils::MakeMaker/Module::Build. | 141 (0.52 %) |
685 (0.75 %) |
2106 (1.06 %) |
| metayml conforms spec current | META.yml does not conform to the Current META.yml Spec (1.4). (defined in Module::CPANTS::Kwalitee::MetaYML) |
Take a look at the META.yml Spec at http://module-build.sourceforge.net/META-spec-current.html and change your META.yml accordingly. | 12216 (45.01 %) |
41013 (45.09 %) |
106287 (53.43 %) |
| metayml declares perl version | This distribution does not declare the minimum perl version in META.yml. (defined in Module::CPANTS::Kwalitee::MetaYML) |
If you are using Build.PL define the {requires}{perl} = VERSION field. If you are using MakeMaker (Makefile.PL) you should upgrade ExtUtils::MakeMaker to 6.48 and use MIN_PERL_VERSION parameter. Perl::MinimumVersion can help you determine which version of Perl your module needs. | 21086 (77.69 %) |
69492 (76.40 %) |
156438 (78.64 %) |
| use warnings | This distribution does not 'use warnings;' in all of its modules. (defined in Module::CPANTS::Kwalitee::Uses) |
Add 'use warnings' to all modules. (This will require perl > 5.6) | 10031 (36.96 %) |
38106 (41.89 %) |
91754 (46.13 %) |
| is prereq | This distribution is not required by another distribution by another author. (defined in Module::CPANTS::SiteKwalitee::Prereq) |
Convince / force / bribe another CPAN author to use this distribution. | 20695 (76.25 %) |
55905 (61.46 %) |
115469 (58.05 %) |
| prereq matches use | This distribution uses a module or a dist that's not listed as a prerequisite. (defined in Module::CPANTS::SiteKwalitee::Prereq) |
List all used modules in META.yml requires | 5014 (18.47 %) |
22945 (25.23 %) |
53860 (27.08 %) |
| Name | Description | Remedy | Fail (Latest) | Fail (CPAN) | Fail (BackPAN) |
|---|---|---|---|---|---|
| no large files | This distribution has at least one file larger than 200000 bytes) (defined in Module::CPANTS::Kwalitee::Files) |
No remedy for that. | 954 (3.52 %) |
5048 (5.55 %) |
12567 (6.32 %) |
| metayml has provides | This distribution does not have a list of provided modules defined in META.yml. (defined in Module::CPANTS::Kwalitee::MetaYML) |
Add all modules contained in this distribution to the META.yml field 'provides'. Module::Build does this automatically for you. | 22140 (81.58 %) |
74912 (82.36 %) |
163579 (82.23 %) |
| has version in each file | This distribution has a .pm file without version number. (Using Parse::PMFile to match them) (defined in Module::CPANTS::Kwalitee::Version) |
Add a version number to each .pm file. | 909 (3.35 %) |
7453 (8.19 %) |
21715 (10.92 %) |
| has separate license file | This distribution does not have a LICENSE or LICENCE file in its root directory. (defined in Module::CPANTS::Kwalitee::License) |
This is not a critical issue. Currently mainly informative for the CPANTS authors. It might be removed later. | 19988 (73.65 %) |
67588 (74.30 %) |
151492 (76.16 %) |
| has license in source file | Does not have license information in any of its source files (defined in Module::CPANTS::Kwalitee::License) |
Add =head1 LICENSE and the text of the license to the main module in your code. | 8997 (33.15 %) |
29591 (32.53 %) |
69580 (34.98 %) |
| fits fedora license | Fits the licensing requirements of Fedora (Acceptable licenses: (perl, apache, artistic_2, gpl, lgpl, mit, mozilla)). (defined in Module::CPANTS::Kwalitee::License) |
Replace the license or convince Fedora to accept this license as well. | 12969 (47.79 %) |
41462 (45.58 %) |
100275 (50.41 %) |
| build prereq matches use | This distribution uses a module or a dist in it's test suite that's not listed as a build prerequisite. (defined in Module::CPANTS::SiteKwalitee::Prereq) |
List all modules used in the test suite in META.yml build_requires | 2224 (8.19 %) |
11786 (12.96 %) |
24888 (12.51 %) |
| easily repackageable by debian | It is easy to repackage this module by Debian. (defined in Module::CPANTS::Kwalitee::Repackageable) |
Fix each one of the metrics this depends on. | 3912 (14.41 %) |
11702 (12.86 %) |
28306 (14.23 %) |
| easily repackageable by fedora | It is easy to repackage this module by Fedora. (defined in Module::CPANTS::Kwalitee::Repackageable) |
Fix each one of the metrics this depends on. | 13046 (48.07 %) |
41727 (45.87 %) |
100864 (50.71 %) |
| easily repackageable | It is easy to repackage this module. See http://www.perlfoundation.org/perl5/index.cgi?cpan_packaging (defined in Module::CPANTS::Kwalitee::Repackageable) |
Fix each one of the metrics this depends on. | 13494 (49.72 %) |
43369 (47.68 %) |
104237 (52.40 %) |