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 This means than many of the usual files you might expect are not in the
  16 repository, but are generated at release time (e.g. Makefile.PL).
  17
  18 However, you can run tests directly using the 'prove' tool:
  19
  20   $ prove -l
  21   $ prove -lv t/some_test_file.t
  22   $ prove -lvr t/
  23
  24 In most cases, 'prove' is entirely sufficent for you to test any
  25 patches you have.
  26
  27 You may need to satisfy some dependencies.  The easiest way to satisfy
  28 dependencies is to install the last release -- this is available at
  29 https://metacpan.org/release/Catalyst-Authentication-Store-Htpasswd
  30
  31 If you use cpanminus, you can do it without downloading the tarball first:
  32
  33   $ cpanm --reinstall --installdeps --with-recommends Catalyst::Authentication::Store::Htpasswd
  34
  35 Dist::Zilla is a very powerful authoring tool, but requires a number of
  36 author-specific plugins.  If you would like to use it for contributing,
  37 install it from CPAN, then run one of the following commands, depending on
  38 your CPAN client:
  39
  40   $ cpan `dzil authordeps --missing`
  41 or
  42   $ dzil authordeps --missing | cpanm
  43
  44 You should then also install any additional requirements not needed by the
  45 dzil build but may be needed by tests or other development:
  46
  47   $ cpan `dzil listdeps --author --missing`
  48 or
  49   $ dzil listdeps --author --missing | cpanm
  50
  51 Or, you can use the 'dzil stale' command to install all requirements at once:
  52
  53   $ cpan Dist::Zilla::App::Command::stale
  54   $ cpan `dzil stale --all`
  55 or
  56   $ cpanm Dist::Zilla::App::Command::stale
  57   $ dzil stale --all | cpanm
  58
  59 You can also do this via cpanm directly:
  60
  61   $ cpanm --reinstall --installdeps --with-develop --with-recommends Catalyst::Authentication::Store::Htpasswd
  62
  63 Once installed, here are some dzil commands you might try:
  64
  65   $ dzil build
  66   $ dzil test
  67   $ dzil test --release
  68   $ dzil xtest
  69   $ dzil listdeps --json
  70   $ dzil build --notgz
  71
  72 You can learn more about Dist::Zilla at http://dzil.org/.
  73
  74 The code for this distribution is hosted at GitHub. The repository is:
  75 https://github.com/perl-catalyst/Catalyst-Authentication-Store-Htpasswd
  76 You can submit code changes by forking the repository, pushing your code
  77 changes to your clone, and then submitting a pull request. Detailed
  78 instructions for doing that is available here:
  79
  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=Catalyst-Authentication-Store-Htpasswd
  85 or via email: bug-Catalyst-Authentication-Store-Htpasswd@rt.cpan.org
  86
  87 There is also a mailing list available for users of this distribution, at
  88 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
  89 There is also an irc channel available for users of this distribution, at
  90 irc://irc.perl.org/#catalyst
  91
  92 If you send me a patch or pull request, your name and email address will be
  93 included in the documentation as a contributor (using the attribution on the
  94 commit or patch), unless you specifically request for it not to be.  If you
  95 wish to be listed under a different name or address, you should submit a pull
  96 request to the .mailmap file to contain the correct mapping.
  97
  98
  99 This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.013 from a
 100 template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.125.