Debian Codegraph @

CONTRIBUTING

raw
1 ## HOW TO CONTRIBUTE
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 ### Getting dependencies
11
12 See the included `cpanfile` file for a list of dependencies. If you have
13 App::cpanminus 1.6 or later installed, you can use `cpanm` to satisfy
14 dependencies like this:
15
16 $ cpanm --installdeps .
17
18 Otherwise, you can install Module::CPANfile 1.0002 or later and then satisfy
19 dependencies with the regular `cpan` client and `cpanfile-dump`:
20
21 $ cpan `cpanfile-dump`
22
23 ### Running tests
24
25 You can run tests directly using the `prove` tool:
26
27 $ prove -l
28 $ prove -lv t/some_test_file.t
29
30 For most distributions, `prove` is entirely sufficent for you to test any
31 patches you have.
32
33 ### Code style and tidying
34
35 Please try to match any existing coding style. If there is a `.perltidyrc`
36 file, please install Perl::Tidy and use perltidy before submitting patches.
37
38 If there is a `tidyall.ini` file, you can also install Code::TidyAll and run
39 `tidyall` on a file or `tidyall -a` to tidy all files.
40
41 ### Patching documentation
42
43 Much of the documentation Pod is generated at release time.
44 Depending on the distribution, some documentation may be written in a Pod
45 dialect called WikiDoc. (See Pod::WikiDoc on CPAN.)
46
47 If you would like to submit a documentation edit, please limit yourself to the
48 documentation you see.
49
50 If you see typos or documentation issues in the generated docs, please
51 email or open a bug ticket instead of patching.
52
53 ### Learning Dist::Zilla
54
55 Dist::Zilla is a very powerful authoring tool, but requires a number of
56 author-specific plugins. If you would like to use it for contributing,
57 install it from CPAN, then run one of the following commands, depending on
58 your CPAN client:
59
60 $ cpan `dzil authordeps`
61 $ dzil authordeps | cpanm
62
63 Once installed, here are some dzil commands you might try:
64
65 $ dzil build
66 $ dzil test
67 $ dzil xtest
68
69 You can learn more about Dist::Zilla at http://dzil.org/
70