Commit | Line | Data |
67523925 |
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 me |
8 | through the bug queue described later in this document, or by emailing me |
9 | directly. You are not required to follow any of the steps in this document to |
10 | submit a patch or bug report; these are just guidelines, intended to help you. |
11 | |
12 | The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla). |
13 | However, you can still compile and test the code with a small Makefile.PL |
14 | specifically for use in the repository. You can do: |
15 | |
16 | perl Makefile.PL |
17 | make |
18 | make test |
19 | |
20 | As well as: |
21 | |
22 | $ prove -bvr t |
23 | or |
24 | $ perl -Mblib t/some_test_file.t |
25 | |
26 | You may need to satisfy some dependencies. The easiest way to satisfy |
27 | dependencies is to install the last release -- this is available at |
28 | https://metacpan.org/release/Sub-Name. |
29 | |
30 | If you use cpanminus, you can do it without downloading the tarball first: |
31 | |
32 | $ cpanm --reinstall --installdeps --with-recommends Sub::Name |
33 | |
34 | Dist::Zilla is a very powerful authoring tool, but requires a number of |
35 | author-specific plugins. If you would like to use it for contributing, |
36 | install it from CPAN, then run one of the following commands, depending on |
37 | your CPAN client: |
38 | |
39 | $ cpan `dzil authordeps --missing` |
40 | or |
41 | $ dzil authordeps --missing | cpanm |
42 | |
43 | You should then also install any additional requirements not needed by the |
44 | dzil build but may be needed by tests or other development: |
45 | |
46 | $ cpan `dzil listdeps --author --missing` |
47 | or |
48 | $ dzil listdeps --author --missing | cpanm |
49 | |
50 | Or, you can use the 'dzil stale' command to install all requirements at once: |
51 | |
52 | $ cpan Dist::Zilla::App::Command::stale |
53 | $ cpan `dzil stale --all` |
54 | or |
55 | $ cpanm Dist::Zilla::App::Command::stale |
56 | $ dzil stale --all | cpanm |
57 | |
58 | You can also do this via cpanm directly: |
59 | |
60 | $ cpanm --reinstall --installdeps --with-develop --with-recommends Sub::Name |
61 | |
62 | Once installed, here are some dzil commands you might try: |
63 | |
64 | $ dzil build |
65 | $ dzil test |
66 | $ dzil test --release |
67 | $ dzil xtest |
68 | $ dzil listdeps --json |
69 | $ dzil build --notgz |
70 | |
71 | You can learn more about Dist::Zilla at http://dzil.org/. |
72 | |
73 | The code for this distribution is hosted at GitHub. The repository is: |
74 | https://github.com/karenetheridge/Sub-Name |
75 | You can submit code changes by forking the repository, pushing your code |
76 | changes to your clone, and then submitting a pull request. Detailed |
77 | instructions for doing that is available here: |
78 | |
79 | https://help.github.com/ |
80 | https://help.github.com/articles/creating-a-pull-request |
81 | |
82 | If you have found a bug, but do not have an accompanying patch to fix it, you |
83 | can submit an issue report here: |
84 | https://rt.cpan.org/Public/Dist/Display.html?Name=Sub-Name |
85 | or via bug-Sub-Name@rt.cpan.org. |
86 | This is a good place to send your questions about the usage of this distribution. |
87 | |
88 | If you send me a patch or pull request, your name and email address will be |
89 | included in the documentation as a contributor, unless you specifically |
90 | request for it not to be (using the attribution on the commit or patch). |
91 | If you wish to be listed under a different name, you should submit a pull |
92 | request to the .mailmap file to contain the correct mapping. |
93 | |
94 | |
95 | This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.005 from a |
00d17844 |
96 | template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.072. |