| Commit | Line | Data |
|---|
| e40eb4d8 |
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 | The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla). |
| 8 | This means than many of the usual files you might expect are not in the |
| 9 | repository, but are generated at release time (e.g. Makefile.PL). |
| 10 | |
| 11 | However, you can run tests directly using the 'prove' tool: |
| 12 | |
| 13 | $ prove -l |
| 14 | $ prove -lv t/some_test_file.t |
| 15 | $ prove -lvr t/ |
| 16 | |
| 17 | In most cases, 'prove' is entirely sufficent for you to test any |
| 18 | patches you have. |
| 19 | |
| 20 | You may need to satisfy some dependencies. The easiest way to satisfy |
| 21 | dependencies is to install the last release -- this is available at |
| 22 | https://metacpan.org/release/Devel-REPL. |
| 23 | |
| 24 | If you use cpanminus, you can do it without downloading the tarball first: |
| 25 | |
| 26 | $ cpanm --reinstall --installdeps --with-recommends Devel::REPL |
| 27 | |
| 28 | Dist::Zilla is a very powerful authoring tool, but requires a number of |
| 29 | author-specific plugins. If you would like to use it for contributing, |
| 30 | install it from CPAN, then run one of the following commands, depending on |
| 31 | your CPAN client: |
| 32 | |
| 33 | $ cpan `dzil authordeps --missing` |
| 34 | or |
| 35 | $ dzil authordeps --missing | cpanm |
| 36 | |
| 37 | You should then also install any additional requirements not needed by the |
| 38 | dzil build but may be needed by tests or other development: |
| 39 | |
| 40 | $ cpan `dzil listdeps --author --missing` |
| 41 | or |
| 42 | $ dzil listdeps --author --missing | cpanm |
| 43 | |
| 44 | Or, you can use the 'dzil stale' command to install all requirements at once: |
| 45 | |
| 46 | $ cpan Dist::Zilla::App::Command::stale |
| 47 | $ cpan `dzil stale --all` |
| 48 | or |
| 49 | $ cpanm Dist::Zilla::App::Command::stale |
| 50 | $ dzil stale --all | cpanm |
| 51 | |
| 52 | You can also do this via cpanm directly: |
| 53 | |
| 54 | $ cpanm --reinstall --installdeps --with-develop --with-recommends Devel::REPL |
| 55 | |
| 56 | Once installed, here are some dzil commands you might try: |
| 57 | |
| 58 | $ dzil build |
| 59 | $ dzil test |
| 60 | $ dzil test --release |
| 61 | $ dzil xtest |
| 62 | $ dzil listdeps --json |
| 63 | $ dzil build --notgz |
| 64 | |
| 65 | You can learn more about Dist::Zilla at http://dzil.org/. |
| 66 | |
| 67 | |
| 68 | If you have found a bug, but do not have an accompanying patch to fix it, you |
| 69 | can submit an issue report here: |
| 70 | https://rt.cpan.org/Public/Dist/Display.html?Name=Devel-REPL |
| 71 | or via bug-Devel-REPL@rt.cpan.org. |
| 72 | This is a good place to send your questions about the usage of this distribution. |
| 73 | |
| 74 | |
| 75 | This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.005 from a |
| 76 | template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.065. |
projects / p5sagit/Devel-REPL.git / blame