Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 43 lines (29 sloc) 1.422 kb
013a36a @dagolden add README files and META
dagolden authored
1 README.PATCHING
2
3 Thank you for considering contributing to this distribution. This file
4 contains instructions that will help you work with the source code.
5
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).
9
10 However, you can run tests directly using the 'prove' tool:
11
12 $ prove -l
13 $ prove -lv t/some_test_file.t
14
15 For most distributions, 'prove' is entirely sufficent for you to test any
16 patches you have.
17
18 Likewise, much of the documentation Pod is generated at release time.
19 Depending on the distribution, some documentation may be written in a Pod
20 dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) If you would like to
21 submit a documentation edit, please limit yourself to the documentation you
22 see.
23
24 If you see typos or documentation issues in the generated docs, please
25 email or open a bug ticket instead of patching.
26
27 Dist::Zilla is a very powerful authoring tool, but requires a number of
28 author-specific plugins. If you would like to use it for contributing,
29 install it from CPAN, then run one of the following commands, depending on
30 your CPAN client:
31
32 $ cpan `dzil authordeps`
33 $ dzil authordeps | cpanm
34
35 Once installed, here are some dzil commands you might try:
36
37 $ dzil build
38 $ dzil test
39 $ dzil xtest
40
41 You can learn more about Dist::Zilla at http://dzil.org/
42
Something went wrong with that request. Please try again.