Skip to content

Release Preparation, Resolve kwalitee issues - #24

Merged
und3f merged 2 commits into
masterfrom
resolve-kwalitee-issues
Feb 4, 2026
Merged

und3f merged 2 commits into
masterfrom
resolve-kwalitee-issues

Conversation

@und3f

@und3f und3f commented Feb 4, 2026

Copy link
Copy Markdown
Owner

No description provided.

@und3f
und3f merged commit a7ddcb8 into master Feb 4, 2026
22 checks passed
Comment thread MANIFEST.SKIP
MYMETA
^\.travis\.yml$
.*\.tar\.gz$
README.pod

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.pod should remain skipped; if it is included in the distribution, it will get errantly installed and indexed by metacpan as documentation

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure? I've added README based on metacpan Kwalitee suggestion:
https://cpants.cpanauthors.org/release/UNDEF/Protocol-Redis-2.0000
has_readme
Add a README to the distribution. It should contain a quick description of your module and how to install it.

And the kwalitee results for the new version are 100% (meaning readme issue was resolved)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but it should not be a file named README.pod because Perl tooling treats pod files as documentation, which README is not. If you want to generate a README or README.md that can be included to satisfy kwalitee.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't come with a commandline tool, but https://metacpan.org/pod/Pod::Readme::Brief is a nice way to generate a plain text README. I generally have dzil do it in the build.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, would do

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants