Dist::Zilla::Plugin::ReadmeAddDevInfo - Dist::Zilla::Plugin::ReadmeAddDevInfo - add info how to contribute to the project
version 0.03
# in dist.ini [ReadmeAddDevInfo] phase = release
[ReadmeAddDevInfo] phase = release
Which Dist::Zilla phase to add the info: build, release or filemunge. For the build and release phases, the README that is on disk will be modified, whereas for the filemunge it's the internal zilla version of the README that will be modified.
build
release
filemunge
The default is build.
[ReadmeAddDevInfo] before = # AUTHOR
Where to put the info in. In this example the info is added before the "AUTHOR" section.
[ReadmeAddDevInfo] add_contribution_file = 1
Also add the info as CONTRIBUTING.md. The information from this file is shown in MetaCPAN under the "How to contribute" link. E.g. for this dist: How to contribute.
Minilla, Dist::Zilla::Plugin::TravisCI::StatusBadge
Renee Baecker <reneeb@cpan.org>
This software is Copyright (c) 2018 by Renee Baecker.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
To install Dist::Zilla::Plugin::ReadmeAddDevInfo, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Plugin::ReadmeAddDevInfo
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Plugin::ReadmeAddDevInfo
For more information on module installation, please visit the detailed CPAN module installation guide.