Subject: | new kwalitee metrics: best practices relating to Dist::Zilla |
This ticket is for sketching out ideas I have for a new analysis module that will contain kwalitee metrics for Dist::Zilla usage.
- we can detect dzil usage by looking for a few things like generated_by => 'Dist::Zilla version ...' in metadata, or "# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker" in Makefile.PL.
- dzil is used, but dist.ini is not present in the distribution -- not a kwalitee failure but it's not a good idea to omit this file, so people can easily see how the distribution was built (e.g. diagnosing problems)
- dzil is used, but META.json is missing: not a good thing. We would like META.json to be present regardless, but it is effortless for dzil users to include it so [MetaJSON] should always be used.
- dzil is used, with files named t/pod.t, t/pod-spelling.t, (..more files that are often included as placeholders in distributions) -- these indicate tests written manually, rather than included via plugins (which would name them either t/release-... or xt/author/... instead)
- more to come