1Dist::Zilla::Plugin::GiUts:e:rCoCnotnrtirbiubtuotresdD(i3Ps)etr:l:ZDiolcluam:e:nPtlautgiionn::Git::Contributors(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::Git::Contributors - Add contributor names from git
7       to your distribution
8

VERSION

10       version 0.035
11

SYNOPSIS

13       In your dist.ini:
14
15           [Git::Contributors]
16

DESCRIPTION

18       This is a Dist::Zilla plugin that extracts all names and email
19       addresses from git commits in your repository and adds them to the
20       distribution metadata under the "x_contributors" key.  It takes a
21       minimalist approach to this -- no data is stuffed into other locations,
22       including stashes -- if other plugins wish to work with this
23       information, they should extract it from the distribution metadata.
24

26       This module uses unicode comparison routines as well as casefolding
27       semantics (when available); Perl 5.016 is recommended.
28

CONFIGURATION OPTIONS

30   "include_authors"
31       When true, authors (as defined by the preamble section in your
32       dist.ini) are added to the list of contributors. When false, authors
33       are filtered out of the list of contributors.  Defaults to false.
34
35   "include_releaser"
36       Defaults to true; set to false to remove the current user (who is doing
37       the distribution release) from the contributors list. It is applied
38       after "include_authors", so you will be removed from the list even if
39       you are (one of the) distribution author(s) and "include_authors = 1".
40
41       You probably don't want this option -- it was added experimentally to
42       change how contributors are displayed on <http://metacpan.org>, but it
43       was decided that this should be managed at a different layer than the
44       metadata.
45
46   "order_by"
47       When "order_by = name", contributors are sorted alphabetically
48       (ascending); when "order_by = commits", contributors are sorted by
49       number of commits made to the repository (descending). The default
50       value is "name".
51
52   "path"
53       Available since version 0.007.
54
55       Indicates a path, relative to the repository root, to search for
56       commits in.  Technically: "Consider only commits that are enough to
57       explain how the files that match the specified paths came to be."
58       Defaults to the repository root. Can be used more than once.  You
59       should almost certainly not need this.
60
61   "remove"
62       Available since version 0.011.
63
64       Any contributor entry matching this regular expression is removed from
65       inclusion.  Can be used more than once.
66

CANONICALIZING NAMES AND ADDRESSES

68       If you or a contributor uses multiple names and/or email addresses to
69       make commits and would like them mapped to a canonical value (e.g.
70       their "cpan.org" address), you can do this by adding a .mailmap file to
71       your git repository, with entries formatted as described in "MAPPING
72       AUTHORS" in "git help shortlog"
73       (<https://www.kernel.org/pub/software/scm/git/docs/git-shortlog.html>).
74
75       Duplicate names that share the same email address will be removed
76       automatically (keeping the form associated with the latest commit).
77

ADDING CONTRIBUTORS TO POD DOCUMENTATION

79       You can add the contributor names to your module documentation by using
80       Pod::Weaver in conjunction with Pod::Weaver::Section::Contributors.
81

UNICODE SUPPORT

83       This module aims to properly handle non-ascii characters in contributor
84       names.  However, on Windows you might need to do a bit more: see
85       <https://github.com/msysgit/msysgit/wiki/Git-for-Windows-Unicode-Support>
86       for supported versions and extra configurations you may need to apply.
87

SEE ALSO

89       ·   How I'm using Dist::Zilla to give credit to contributors
90           <http://www.dagolden.com/index.php/1921/how-im-using-distzilla-to-
91           give-credit-to-contributors/>
92
93       ·   Pod::Weaver::Section::Contributors - weaves x_contributors data
94           into a pod section
95
96       ·   Dist::Zilla::Plugin::Meta::Contributors - adds an explicit list of
97           names to x_contributors
98
99       ·   Dist::Zilla::Plugin::ContributorsFromGit - more dependencies,
100           problematic tests, passes around a lot of extra data in stashes
101           unnecessarily
102
103       ·   Dist::Zilla::Plugin::ContributorsFromPod - takes the list of
104           contributors from pod
105
106       ·   Module::Install::Contributors
107
108       ·   Dist::Zilla::Plugin::ContributorsFile - adds CONTRIBUTORS file,
109           containing names from x_contributors metadata
110

SUPPORT

112       Bugs may be submitted through the RT bug tracker
113       <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-
114       Git-Contributors> (or
115       bug-Dist-Zilla-Plugin-Git-Contributors@rt.cpan.org <mailto:bug-Dist-
116       Zilla-Plugin-Git-Contributors@rt.cpan.org>).
117
118       There is also a mailing list available for users of this distribution,
119       at <http://dzil.org/#mailing-list>.
120
121       There is also an irc channel available for users of this distribution,
122       at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>.
123
124       I am also usually active on irc, as 'ether' at "irc.perl.org".
125

AUTHOR

127       Karen Etheridge <ether@cpan.org>
128

CONTRIBUTORS

130       ·   Kent Fredric <kentnl@cpan.org>
131
132       ·   Matthew Horsfall <wolfsage@gmail.com>
133
134       ·   Mohammad S Anwar <mohammad.anwar@yahoo.com>
135
136       ·   Ricardo Signes <rjbs@cpan.org>
137
138       ·   Klaus Eichner <klaus03@gmail.com>
139
140       ·   Ioan Rogers <ioan@dirtysoft.ca>
141

143       This software is copyright (c) 2014 by Karen Etheridge.
144
145       This is free software; you can redistribute it and/or modify it under
146       the same terms as the Perl 5 programming language system itself.
147
148
149
150perl v5.30.1                      2020D-i0s1t-:2:9Zilla::Plugin::Git::Contributors(3)
Impressum