NAME
Software::Policies - Create policy files: CODE_OF_CONDUCT, CONTRIBUTING, FUNDING, GOVERNANCE, SECURITY, SUPPORT, etc.
VERSION
version 0.002
SYNOPSIS
use Software::Policies;
my $policies = Software::Policies->new;
my $contributing = $policies->create(
policy => 'Contributing',
class => 'Simple',
version => '1',
format => 'markdown',
attributes => { },
);DESCRIPTION
Software-Policies is a framework for creating different policy and related, such as license, files which are commonly present in repositories. Many of these are practically boilerplate but it is good to have them present in the repository, especially if the repository is public.
Some public hosting sites, such as GitHub, place extra weight on these files, and having them is seen as an indicator of project health and of being welcoming community engagement.
With this package, creating the files is quick and easy.
Current supported are:
- Contributing
- CodeOfConduct
- Security
- License
STATUS
Software-Policies is currently being developed so changes in the API are possible, though not likely.
METHODS
new
Create Software::Policies object.
list
List all available policies, classes and versions.
Arguments
- policy
-
Only list classes and version of this policy.
create
Create a policy and return it as a text string.
SEE ALSO
If you use Dist::Zilla as your project distribution builder, please take a look at https://metacpan.org/pod/Dist::Zilla::App::Cmd::policies to generate the files based on information in your dist.ini file and at https://metacpan.org/pod/Dist::Zilla::Test::Software::Policies to test the files are kept updated at every release. These modules are in the https://metacpan.org/pod/Dist::Zilla::Plugin::Softare::Policies distribution.
Software::Policy::CodeOfConduct can create a Code Of Conduct policy using the Contributor Covenant templates.
Software::Security::Policy can create a Security Policy following the guidelines of <CPAN Security Group|https://security.metacpan.org/>.
GitHub has a list of Supported File Types.
AUTHOR
Mikko Koivunalho <mikkoi@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2025 by Mikko Koivunalho.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.