New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve dist.ini to fix a CPANTS warning #5

Open
wants to merge 3 commits into
base: master
from

Conversation

Projects
None yet
1 participant
@kyzn

kyzn commented Feb 28, 2015

The mentioned warning can be seen at http://cpants.cpanauthors.org/dist/Dancer-Plugin-Auth-Basic
It's obviously not an urgent (or even necessary) fix, yet I wanted to contribute (even small) as part of CPAN PR Challenge.

I was advised on pr-challenge dedicated IRC channel that adding a simple [Readme] to the end of dist.ini would fix the issue, hence the PR. I've seen ReadmeAnyFromPod / ReadmePodInRoot in your Dist Zilla Plugin Bundle, but either (a) it was not considered as a readme by CPANTS or (b) files you have uploaded to CPAN did miss a readme file, unlike GitHub repo (which has a great readme).

To note it again, as the warning is not crucial, this contribution may not be very constructive. There might even be simpler solutions to the noted warning.

kyzn added some commits Feb 28, 2015

Added [Readme] to fix CPANTS warning has-readme
Description on CPANTS is as follows:
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.

I was advised that this commit would fix it on #pr-challenge irc channel.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment