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