4 Thank you for considering contributing to this distribution. This file
5 contains instructions that will help you work with the source code.
7 PLEASE NOTE that if you have any questions or difficulties, you can reach the
8 maintainer(s) through the bug queue described later in this document
9 (preferred), or by emailing the releaser directly. You are not required to
10 follow any of the steps in this document to submit a patch or bug report;
11 these are just recommendations, intended to help you (and help us help you
14 This distribution has a TODO file in the repository; you may want to check
15 there to see if your issue or patch idea is mentioned.
17 The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
18 However, you can still compile and test the code with a small Makefile.PL
19 specifically for use in the repository. You can do:
29 $ perl -Mblib t/some_test_file.t
31 You may need to satisfy some dependencies. The easiest way to satisfy
32 dependencies is to install the last release -- this is available at
33 https://metacpan.org/release/Sub-Name
35 If you use cpanminus, you can do it without downloading the tarball first:
37 $ cpanm --reinstall --installdeps --with-recommends Sub::Name
39 Dist::Zilla is a very powerful authoring tool, but requires a number of
40 author-specific plugins. If you would like to use it for contributing,
41 install it from CPAN, then run one of the following commands, depending on
44 $ cpan `dzil authordeps --missing`
46 $ dzil authordeps --missing | cpanm
48 You should then also install any additional requirements not needed by the
49 dzil build but may be needed by tests or other development:
51 $ cpan `dzil listdeps --author --missing`
53 $ dzil listdeps --author --missing | cpanm
55 Or, you can use the 'dzil stale' command to install all requirements at once:
57 $ cpan Dist::Zilla::App::Command::stale
58 $ cpan `dzil stale --all`
60 $ cpanm Dist::Zilla::App::Command::stale
61 $ dzil stale --all | cpanm
63 You can also do this via cpanm directly:
65 $ cpanm --reinstall --installdeps --with-develop --with-recommends Sub::Name
67 Once installed, here are some dzil commands you might try:
73 $ dzil listdeps --json
76 You can learn more about Dist::Zilla at http://dzil.org/.
78 The code for this distribution is hosted at GitHub. The repository is:
79 https://github.com/p5sagit/Sub-Name
80 You can submit code changes by forking the repository, pushing your code
81 changes to your clone, and then submitting a pull request. Detailed
82 instructions for doing that is available here:
84 https://help.github.com/articles/creating-a-pull-request
86 If you have found a bug, but do not have an accompanying patch to fix it, you
87 can submit an issue report here:
88 https://rt.cpan.org/Public/Dist/Display.html?Name=Sub-Name
89 or via email: bug-Sub-Name@rt.cpan.org
91 There is also an irc channel available for users of this distribution, at
92 irc://irc.perl.org/#toolchain
94 If you send me a patch or pull request, your name and email address will be
95 included in the documentation as a contributor (using the attribution on the
96 commit or patch), unless you specifically request for it not to be. If you
97 wish to be listed under a different name or address, you should submit a pull
98 request to the .mailmap file to contain the correct mapping.
101 This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.012 from a
102 template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.121.