NAME
Dist::Zilla::Plugin::Git::Contributors - Add contributor names from git to your distribution
VERSION
version 0.001
SYNOPSIS
In your dist.ini:
[Git::Contributors]DESCRIPTION
This is a Dist::Zilla plugin that extracts all names and email addresses from git commits in your repository and adds them to the distribution metadata under the x_contributors key. It takes a minimalist approach to this -- no data is stuffed into other locations, including stashes -- if other plugins wish to work with this information, they should extract it from the distribution metadata.
CONFIGURATION OPTIONS
include_authors
By default, distribution authors are removed from the list of extracted git contributors. To disable this, set include_authors = 1.
CANONICALIZING NAMES AND ADDRESSES
If you or a contributor uses multiple names and/or email addresses to make commits and would like them mapped to a canonical value, you can do this by adding a .mailmap file to your git repository, with entries formatted as described in "MAPPING AUTHORS" in git help shortlog (https://www.kernel.org/pub/software/scm/git/docs/git-shortlog.html).
ADDING CONTRIBUTORS TO POD DOCUMENTATION
You can add the contributor names to your module documentation by using Pod::Weaver in conjunction with Pod::Weaver::Section::Contributors.
SUPPORT
Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-Git-Contributors@rt.cpan.org). I am also usually active on irc, as 'ether' at irc.perl.org.
SEE ALSO
AUTHOR
Karen Etheridge <ether@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Karen Etheridge.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.