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