Blame CONTRIBUTING

Packit a89ea5
Packit a89ea5
CONTRIBUTING
Packit a89ea5
Packit a89ea5
Thank you for considering contributing to this distribution.  This file
Packit a89ea5
contains instructions that will help you work with the source code.
Packit a89ea5
Packit a89ea5
PLEASE NOTE that if you have any questions or difficulties, you can reach the
Packit a89ea5
maintainer(s) through the bug queue described later in this document
Packit a89ea5
(preferred), or by emailing the releaser directly. You are not required to
Packit a89ea5
follow any of the steps in this document to submit a patch or bug report;
Packit a89ea5
these are just recommendations, intended to help you (and help us help you
Packit a89ea5
faster).
Packit a89ea5
Packit a89ea5
The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
Packit a89ea5
This means than many of the usual files you might expect are not in the
Packit a89ea5
repository, but are generated at release time (e.g. Makefile.PL).
Packit a89ea5
Packit a89ea5
However, you can run tests directly using the 'prove' tool:
Packit a89ea5
Packit a89ea5
  $ prove -l
Packit a89ea5
  $ prove -lv t/some_test_file.t
Packit a89ea5
  $ prove -lvr t/
Packit a89ea5
Packit a89ea5
In most cases, 'prove' is entirely sufficient for you to test any
Packit a89ea5
patches you have.
Packit a89ea5
Packit a89ea5
You may need to satisfy some dependencies.  The easiest way to satisfy
Packit a89ea5
dependencies is to install the last release -- this is available at
Packit a89ea5
https://metacpan.org/release/File-Temp
Packit a89ea5
Packit a89ea5
If you use cpanminus, you can do it without downloading the tarball first:
Packit a89ea5
Packit a89ea5
  $ cpanm --reinstall --installdeps --with-recommends File::Temp
Packit a89ea5
Packit a89ea5
Dist::Zilla is a very powerful authoring tool, but requires a number of
Packit a89ea5
author-specific plugins.  If you would like to use it for contributing,
Packit a89ea5
install it from CPAN, then run one of the following commands, depending on
Packit a89ea5
your CPAN client:
Packit a89ea5
Packit a89ea5
  $ cpan `dzil authordeps --missing`
Packit a89ea5
or
Packit a89ea5
  $ dzil authordeps --missing | cpanm
Packit a89ea5
Packit a89ea5
You should then also install any additional requirements not needed by the
Packit a89ea5
dzil build but may be needed by tests or other development:
Packit a89ea5
Packit a89ea5
  $ cpan `dzil listdeps --author --missing`
Packit a89ea5
or
Packit a89ea5
  $ dzil listdeps --author --missing | cpanm
Packit a89ea5
Packit a89ea5
Or, you can use the 'dzil stale' command to install all requirements at once:
Packit a89ea5
Packit a89ea5
  $ cpan Dist::Zilla::App::Command::stale
Packit a89ea5
  $ cpan `dzil stale --all`
Packit a89ea5
or
Packit a89ea5
  $ cpanm Dist::Zilla::App::Command::stale
Packit a89ea5
  $ dzil stale --all | cpanm
Packit a89ea5
Packit a89ea5
You can also do this via cpanm directly:
Packit a89ea5
Packit a89ea5
  $ cpanm --reinstall --installdeps --with-develop --with-recommends File::Temp
Packit a89ea5
Packit a89ea5
Once installed, here are some dzil commands you might try:
Packit a89ea5
Packit a89ea5
  $ dzil build
Packit a89ea5
  $ dzil test
Packit a89ea5
  $ dzil test --release
Packit a89ea5
  $ dzil xtest
Packit a89ea5
  $ dzil listdeps --json
Packit a89ea5
  $ dzil build --notgz
Packit a89ea5
Packit a89ea5
You can learn more about Dist::Zilla at http://dzil.org/.
Packit a89ea5
Packit a89ea5
The code for this distribution is hosted at GitHub. The repository is:
Packit a89ea5
https://github.com/Perl-Toolchain-Gang/File-Temp
Packit a89ea5
You can submit code changes by forking the repository, pushing your code
Packit a89ea5
changes to your clone, and then submitting a pull request. Detailed
Packit a89ea5
instructions for doing that is available here:
Packit a89ea5
Packit a89ea5
https://help.github.com/articles/creating-a-pull-request
Packit a89ea5
Packit a89ea5
If you have found a bug, but do not have an accompanying patch to fix it, you
Packit a89ea5
can submit an issue report here:
Packit a89ea5
https://rt.cpan.org/Public/Dist/Display.html?Name=File-Temp
Packit a89ea5
or via email: bug-File-Temp@rt.cpan.org
Packit a89ea5
Packit a89ea5
There is also a mailing list available for users of this distribution, at
Packit a89ea5
http://lists.perl.org/list/cpan-workers.html
Packit a89ea5
There is also an irc channel available for users of this distribution, at
Packit a89ea5
irc://irc.perl.org/#toolchain
Packit a89ea5
Packit a89ea5
If you send me a patch or pull request, your name and email address will be
Packit a89ea5
included in the documentation as a contributor (using the attribution on the
Packit a89ea5
commit or patch), unless you specifically request for it not to be.  If you
Packit a89ea5
wish to be listed under a different name or address, you should submit a pull
Packit a89ea5
request to the .mailmap file to contain the correct mapping.
Packit a89ea5
Packit a89ea5
Packit a89ea5
This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.014 from a
Packit a89ea5
template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.141.