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 The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
  15 However, you can still compile and test the code with a small Makefile.PL
  16 specifically for use in the repository.  You can do:
  17
  18     perl Makefile.PL
  19     make
  20     make test
  21
  22 As well as:
  23
  24   $ prove -bvr t
  25 or
  26   $ perl -Mblib t/some_test_file.t
  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/Sub-Name.
  31
  32 If you use cpanminus, you can do it without downloading the tarball first:
  33
  34   $ cpanm --reinstall --installdeps --with-recommends Sub::Name
  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 Sub::Name
  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/karenetheridge/Sub-Name
  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=Sub-Name
  86 or via bug-Sub-Name@rt.cpan.org.
  87 This is a good place to send your questions about the usage of this distribution.
  88
  89 If you send me a patch or pull request, your name and email address will be
  90 included in the documentation as a contributor (using the attribution on the
  91 commit or patch), unless you specifically request for it not to be.  If you
  92 wish to be listed under a different name or address, you should submit a pull
  93 request to the .mailmap file to contain the correct mapping.
  94
  95
  96 This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.005 from a
  97 template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.092.