document the new repository(ies)
[p5sagit/Sub-Name.git] / CONTRIBUTING
CommitLineData
67523925 1
2CONTRIBUTING
3
4Thank you for considering contributing to this distribution. This file
5contains instructions that will help you work with the source code.
6
6eb2af6c 7PLEASE NOTE that if you have any questions or difficulties, you can reach the
8maintainer(s) through the bug queue described later in this document
9(preferred), or by emailing the releaser directly. You are not required to
10follow any of the steps in this document to submit a patch or bug report;
11these are just recommendations, intended to help you (and help us help you
12faster).
67523925 13
14The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
15However, you can still compile and test the code with a small Makefile.PL
16specifically for use in the repository. You can do:
17
18 perl Makefile.PL
19 make
20 make test
21
22As well as:
23
24 $ prove -bvr t
25or
26 $ perl -Mblib t/some_test_file.t
27
28You may need to satisfy some dependencies. The easiest way to satisfy
29dependencies is to install the last release -- this is available at
30https://metacpan.org/release/Sub-Name.
31
32If you use cpanminus, you can do it without downloading the tarball first:
33
34 $ cpanm --reinstall --installdeps --with-recommends Sub::Name
35
36Dist::Zilla is a very powerful authoring tool, but requires a number of
37author-specific plugins. If you would like to use it for contributing,
38install it from CPAN, then run one of the following commands, depending on
39your CPAN client:
40
41 $ cpan `dzil authordeps --missing`
42or
43 $ dzil authordeps --missing | cpanm
44
45You should then also install any additional requirements not needed by the
46dzil build but may be needed by tests or other development:
47
48 $ cpan `dzil listdeps --author --missing`
49or
50 $ dzil listdeps --author --missing | cpanm
51
52Or, you can use the 'dzil stale' command to install all requirements at once:
53
54 $ cpan Dist::Zilla::App::Command::stale
55 $ cpan `dzil stale --all`
56or
57 $ cpanm Dist::Zilla::App::Command::stale
58 $ dzil stale --all | cpanm
59
60You can also do this via cpanm directly:
61
62 $ cpanm --reinstall --installdeps --with-develop --with-recommends Sub::Name
63
64Once installed, here are some dzil commands you might try:
65
66 $ dzil build
67 $ dzil test
68 $ dzil test --release
69 $ dzil xtest
70 $ dzil listdeps --json
71 $ dzil build --notgz
72
73You can learn more about Dist::Zilla at http://dzil.org/.
74
75The code for this distribution is hosted at GitHub. The repository is:
76https://github.com/karenetheridge/Sub-Name
77You can submit code changes by forking the repository, pushing your code
78changes to your clone, and then submitting a pull request. Detailed
79instructions for doing that is available here:
80
67523925 81https://help.github.com/articles/creating-a-pull-request
82
83If you have found a bug, but do not have an accompanying patch to fix it, you
84can submit an issue report here:
85https://rt.cpan.org/Public/Dist/Display.html?Name=Sub-Name
86or via bug-Sub-Name@rt.cpan.org.
87This is a good place to send your questions about the usage of this distribution.
88
89If you send me a patch or pull request, your name and email address will be
6eb2af6c 90included in the documentation as a contributor (using the attribution on the
91commit or patch), unless you specifically request for it not to be. If you
92wish to be listed under a different name or address, you should submit a pull
67523925 93request to the .mailmap file to contain the correct mapping.
94
95
96This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.005 from a
5b778144 97template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.092.