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.036
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 (unanchored, case-sensitive)
65       regular expression is removed from inclusion.  Can be used more than
66       once.
67

CANONICALIZING NAMES AND ADDRESSES

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

ADDING CONTRIBUTORS TO POD DOCUMENTATION

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

UNICODE SUPPORT

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

SEE ALSO

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

SUPPORT

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

AUTHOR

129       Karen Etheridge <ether@cpan.org>
130

CONTRIBUTORS

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

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