CONTRIBUTING

   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 This distribution has a TODO file in the repository; you may want to check
  15 there to see if your issue or patch idea is mentioned.
  16
  17 The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
  18 This means than many of the usual files you might expect are not in the
  19 repository, but are generated at release time (e.g. Makefile.PL).
  20
  21 However, you can run tests directly using the 'prove' tool:
  22
  23   $ prove -l
  24   $ prove -lv t/some_test_file.t
  25   $ prove -lvr t/
  26
  27 In most cases, 'prove' is entirely sufficent for you to test any
  28 patches you have.
  29
  30 You may need to satisfy some dependencies.  The easiest way to satisfy
  31 dependencies is to install the last release -- this is available at
  32 https://metacpan.org/release/Devel-REPL
  33
  34 If you use cpanminus, you can do it without downloading the tarball first:
  35
  36   $ cpanm --reinstall --installdeps --with-recommends Devel::REPL
  37
  38 Dist::Zilla is a very powerful authoring tool, but requires a number of
  39 author-specific plugins.  If you would like to use it for contributing,
  40 install it from CPAN, then run one of the following commands, depending on
  41 your CPAN client:
  42
  43   $ cpan `dzil authordeps --missing`
  44 or
  45   $ dzil authordeps --missing | cpanm
  46
  47 You should then also install any additional requirements not needed by the
  48 dzil build but may be needed by tests or other development:
  49
  50   $ cpan `dzil listdeps --author --missing`
  51 or
  52   $ dzil listdeps --author --missing | cpanm
  53
  54 Or, you can use the 'dzil stale' command to install all requirements at once:
  55
  56   $ cpan Dist::Zilla::App::Command::stale
  57   $ cpan `dzil stale --all`
  58 or
  59   $ cpanm Dist::Zilla::App::Command::stale
  60   $ dzil stale --all | cpanm
  61
  62 You can also do this via cpanm directly:
  63
  64   $ cpanm --reinstall --installdeps --with-develop --with-recommends Devel::REPL
  65
  66 Once installed, here are some dzil commands you might try:
  67
  68   $ dzil build
  69   $ dzil test
  70   $ dzil test --release
  71   $ dzil xtest
  72   $ dzil listdeps --json
  73   $ dzil build --notgz
  74
  75 You can learn more about Dist::Zilla at http://dzil.org/.
  76
  77 The code for this distribution is hosted at GitHub. The repository is:
  78 https://github.com/p5sagit/Devel-REPL
  79 You can submit code changes by forking the repository, pushing your code
  80 changes to your clone, and then submitting a pull request. Detailed
  81 instructions for doing that is available here:
  82
  83 https://help.github.com/articles/creating-a-pull-request
  84
  85 If you have found a bug, but do not have an accompanying patch to fix it, you
  86 can submit an issue report here:
  87 https://rt.cpan.org/Public/Dist/Display.html?Name=Devel-REPL
  88 or via email: bug-Devel-REPL@rt.cpan.org
  89
  90 There is also an irc channel available for users of this distribution, at
  91 irc://irc.perl.org/#devel-repl
  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::FromShareDir 0.009 from a
 101 template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.111.