1CONTRIBUTING
2
3Thank you for considering contributing to this distribution.  This file
4contains instructions that will help you work with the source code.
5
6The distribution is managed with Dist::Zilla.  This means than many of the
7usual files you might expect are not in the repository, but are generated
8at release time (e.g. Makefile.PL).
9
10However, you can run tests directly using the 'prove' tool:
11
12  $ prove -l
13  $ prove -lv t/some_test_file.t
14
15For most distributions, 'prove' is entirely sufficent for you to test any
16patches you have.
17
18You may need to satisfy some dependencies.  See the included META.json
19file for a list.  If you install App::mymeta_requires from CPAN, it's easy
20to satisfy any that you are missing by piping the output to your favorite
21CPAN client:
22
23  $ mymeta-requires | cpanm
24  $ cpan `mymeta-requires`
25
26Likewise, much of the documentation Pod is generated at release time.
27Depending on the distribution, some documentation may be written in a Pod
28dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) If you would like to
29submit a documentation edit, please limit yourself to the documentation you
30see.
31
32If you see typos or documentation issues in the generated docs, please
33email or open a bug ticket instead of patching.
34
35Dist::Zilla is a very powerful authoring tool, but requires a number of
36author-specific plugins.  If you would like to use it for contributing,
37install it from CPAN, then run one of the following commands, depending on
38your CPAN client:
39
40  $ cpan `dzil authordeps`
41  $ dzil authordeps | cpanm
42
43Once installed, here are some dzil commands you might try:
44
45  $ dzil build
46  $ dzil test
47  $ dzil xtest
48
49You can learn more about Dist::Zilla at http://dzil.org/
50
51