Kwalitee Issues

has_manifest

Add a MANIFEST to the distribution. Your buildtool should be able to autogenerate it (eg "make manifest" or "./Build manifest")

has_meta_yml

Add a META.yml to the distribution. Your buildtool should be able to autogenerate it.

has_changelog

Add a Changelog (best named 'Changes') to the distribution. It should list at least major changes implemented in newer versions.

has_tests

Add tests!

has_human_readable_license

Add a section called "LICENSE" to the documentation, or add a file named LICENSE to the distribution.

has_license_in_source_file

Add =head1 LICENSE and the text of the license to the main module in your code.

manifest_matches_dist

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.

Error: Cannot find MANIFEST in dist.

use_strict

Add 'use strict' (or its equivalents) to all modules, or convince us that your favorite module is well-known enough and people can easily see the modules are strictly written.

Error: Pod::HTML, Pod::RTF, Pod::Simplify

prereq_matches_use

List all used modules in META.yml requires

Error:

  • HTML::AsSubs
  • HTML::Element
  • HTML::Entities

main_module_version_matches_dist_version

Make sure that the main module name and version are the same of the distribution.

no_pod_errors

Remove the POD errors. You can check for POD errors automatically by including Test::Pod to your test suite.

Error: PodSimplify-0.04/Pod/HTML.pm -- Around line 24: '=item' outside of any '=over' =over without closing =back PodSimplify-0.04/Pod/Simplify.pm -- Around line 88: '=item' outside of any '=over' Around line 456: Deleting unknown formatting code R<> Deleting unknown formatting code R<> Around line 985: You forgot a '=back' before '=head1' PodSimplify-0.04/foo.pod -- Around line 1: Unknown directive: =comment Around line 675: Unknown directive: =comment PodSimplify-0.04/newvar.pod -- Around line 45: You can't have =items (as at line 51) unless the first thing after the =over is an =item Around line 47: Unknown directive: =with Around line 49: Unknown directive: =with PodSimplify-0.04/newvar2.pod -- Around line 45: You can't have =items (as at line 51) unless the first thing after the =over is an =item Around line 47: Unknown directive: =with Around line 49: Unknown directive: =with PodSimplify-0.04/test.pod -- Around line 76: '=end module test' is invalid. (Stack: =begin module) Around line 80: '=end module test2' is invalid. (Stack: =begin module; =begin module)

has_meta_json

Add a META.json to the distribution. Your buildtool should be able to autogenerate it.

has_tests_in_t_dir

Add tests or move tests.pl to the t/ directory!

proper_libs

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'. If you need to provide additional files, e.g. for testing, that should not be considered for Kwalitee, then you should look at the 'provides' map in META.yml to limit the files scanned; or use the 'no_index' map to exclude parts of the distribution.

Error: Pod/HTML.pm, Pod/RTF.pm, Pod/Simplify.pm

meta_yml_has_license

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.

has_known_license_in_source_file

Add =head1 LICENSE and/or the proper text of the well-known license to the main module in your code.

use_warnings

Add 'use warnings' (or its equivalents) to all modules, or convince us that your favorite module is well-known enough and people can easily see the modules warn when something bad happens.

Error: Pod::HTML, Pod::RTF, Pod::Simplify

no_unauthorized_packages

Ask the owner of the distribution (the one who released it first, or the one who is designated in x_authority) to give you a (co-)maintainer's permission.

Error:

  • Pod::HTML

has_separate_license_file

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

Modules

Name Abstract Version View
Pod::HTML Translate POD into HTML file metacpan
Pod::RTF metacpan
Pod::Simplify Simplify the pod (Plain Old Documentation) portion of a file metacpan

Other Files

Makefile.PL metacpan
README metacpan