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 However, you can still compile and test the code with a small Makefile.PL
  19 specifically for use in the repository.  You can do:
  20
  21     perl Makefile.PL
  22     make
  23     make test
  24
  25 As well as:
  26
  27   $ prove -bvr t
  28 or
  29   $ perl -Mblib t/some_test_file.t
  30
  31 You may need to satisfy some dependencies.  The easiest way to satisfy
  32 dependencies is to install the last release -- this is available at
  33 https://metacpan.org/release/Sub-Name
  34
  35 If you use cpanminus, you can do it without downloading the tarball first:
  36
  37   $ cpanm --reinstall --installdeps --with-recommends Sub::Name
  38
  39 Dist::Zilla is a very powerful authoring tool, but requires a number of
  40 author-specific plugins.  If you would like to use it for contributing,
  41 install it from CPAN, then run one of the following commands, depending on
  42 your CPAN client:
  43
  44   $ cpan `dzil authordeps --missing`
  45 or
  46   $ dzil authordeps --missing | cpanm
  47
  48 You should then also install any additional requirements not needed by the
  49 dzil build but may be needed by tests or other development:
  50
  51   $ cpan `dzil listdeps --author --missing`
  52 or
  53   $ dzil listdeps --author --missing | cpanm
  54
  55 Or, you can use the 'dzil stale' command to install all requirements at once:
  56
  57   $ cpan Dist::Zilla::App::Command::stale
  58   $ cpan `dzil stale --all`
  59 or
  60   $ cpanm Dist::Zilla::App::Command::stale
  61   $ dzil stale --all | cpanm
  62
  63 You can also do this via cpanm directly:
  64
  65   $ cpanm --reinstall --installdeps --with-develop --with-recommends Sub::Name
  66
  67 Once installed, here are some dzil commands you might try:
  68
  69   $ dzil build
  70   $ dzil test
  71   $ dzil test --release
  72   $ dzil xtest
  73   $ dzil listdeps --json
  74   $ dzil build --notgz
  75
  76 You can learn more about Dist::Zilla at http://dzil.org/.
  77
  78 The code for this distribution is hosted at GitHub. The repository is:
  79 https://github.com/p5sagit/Sub-Name
  80 You can submit code changes by forking the repository, pushing your code
  81 changes to your clone, and then submitting a pull request. Please include a
  82 suitable end-user-oriented entry in the Changes file describing your change.
  83 Detailed instructions for doing that is available here:
  84
  85 https://help.github.com/articles/creating-a-pull-request
  86
  87 All pull requests for this distribution will be automatically tested on Linux
  88 by Travis at: https://travis-ci.com/p5sagit/Sub-Name
  89 Results will be visible in the pull request on GitHub. Follow the appropriate
  90 links for details when tests fail. Changes will not be mergeable until all
  91 tests pass.
  92
  93 If you have found a bug, but do not have an accompanying patch to fix it, you
  94 can submit an issue report here:
  95 https://rt.cpan.org/Public/Dist/Display.html?Name=Sub-Name
  96 or via email: bug-Sub-Name@rt.cpan.org
  97
  98 There is also an irc channel available for users of this distribution, at
  99 irc://irc.perl.org/#toolchain
 100
 101 If you send me a patch or pull request, your name and email address will be
 102 included in the documentation as a contributor (using the attribution on the
 103 commit or patch), unless you specifically request for it not to be.  If you
 104 wish to be listed under a different name or address, you should submit a pull
 105 request to the .mailmap file to contain the correct mapping.
 106
 107
 108 This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.014
 109 from a template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.150.