Debian Codegraph @

CONTRIBUTING

raw
1
2 CONTRIBUTING
3
4 Thank you for considering contributing to this distribution. This file
5 contains instructions that will help you work with the source code.
6
7 PLEASE NOTE that if you have any questions or difficulties, you can reach the
8 maintainer(s) through the bug queue described later in this document
9 (preferred), or by emailing the releaser directly. You are not required to
10 follow any of the steps in this document to submit a patch or bug report;
11 these are just recommendations, intended to help you (and help us help you
12 faster).
13
14
15 The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
16 This means than many of the usual files you might expect are not in the
17 repository, but are generated at release time (e.g. Makefile.PL).
18
19 However, you can run tests directly using the 'prove' tool:
20
21 $ prove -l
22 $ prove -lv t/some_test_file.t
23 $ prove -lvr t/
24
25 In most cases, 'prove' is entirely sufficent for you to test any
26 patches you have.
27
28 You may need to satisfy some dependencies. The easiest way to satisfy
29 dependencies is to install the last release -- this is available at
30 https://metacpan.org/release/Catalyst-Controller-ActionRole.
31
32 If you use cpanminus, you can do it without downloading the tarball first:
33
34 $ cpanm --reinstall --installdeps --with-recommends Catalyst::Controller::ActionRole
35
36 Dist::Zilla is a very powerful authoring tool, but requires a number of
37 author-specific plugins. If you would like to use it for contributing,
38 install it from CPAN, then run one of the following commands, depending on
39 your CPAN client:
40
41 $ cpan `dzil authordeps --missing`
42 or
43 $ dzil authordeps --missing | cpanm
44
45 You should then also install any additional requirements not needed by the
46 dzil build but may be needed by tests or other development:
47
48 $ cpan `dzil listdeps --author --missing`
49 or
50 $ dzil listdeps --author --missing | cpanm
51
52 Or, 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`
56 or
57 $ cpanm Dist::Zilla::App::Command::stale
58 $ dzil stale --all | cpanm
59
60 You can also do this via cpanm directly:
61
62 $ cpanm --reinstall --installdeps --with-develop --with-recommends Catalyst::Controller::ActionRole
63
64 Once 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
73 You can learn more about Dist::Zilla at http://dzil.org/.
74
75 The code for this distribution is hosted at GitHub. The repository is:
76 https://github.com/perl-catalyst/Catalyst-Controller-ActionRole
77 You can submit code changes by forking the repository, pushing your code
78 changes to your clone, and then submitting a pull request. Detailed
79 instructions for doing that is available here:
80
81 https://help.github.com/articles/creating-a-pull-request
82
83 If you have found a bug, but do not have an accompanying patch to fix it, you
84 can submit an issue report here:
85 https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Controller-ActionRole
86 or via [email protected].
87
88 There is also a mailing list available for users of this distribution, at
89 http://wiki.catalystframework.org/wiki/mailinglists.view.
90 There is also an irc channel available for users of this distribution, at
91 irc://irc.perl.org/#catalyst.
92
93 If you send me a patch or pull request, your name and email address will be
94 included in the documentation as a contributor (using the attribution on the
95 commit or patch), unless you specifically request for it not to be. If you
96 wish to be listed under a different name or address, you should submit a pull
97 request to the .mailmap file to contain the correct mapping.
98
99
100 This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.005 from a
101 template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.086.