Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Modernize repo layout and meta files
- Loading branch information
Showing
10 changed files
with
197 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,14 @@ | ||
language: perl | ||
script: HARNESS_IS_VERBOSE=1 prove -l -m -r t | ||
script: prove -lr t | ||
sudo: false | ||
install: | ||
- cpanm -n -q --skip-satisfied --installdeps . | ||
perl: | ||
- "5.22" | ||
- "5.20" | ||
- "5.18" | ||
- "5.16" | ||
- "5.14" | ||
- "5.12" | ||
- "5.10" | ||
- "5.8" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
## HOW TO CONTRIBUTE | ||
|
||
Thank you for considering contributing to this distribution. This file | ||
contains instructions that will help you work with the source code. | ||
|
||
The distribution is managed with Dist::Zilla. This means that many of the | ||
usual files you might expect are not in the repository, but are generated at | ||
release time, as is much of the documentation. Some generated files are | ||
kept in the repository as a convenience (e.g. Makefile.PL or cpanfile). | ||
|
||
Generally, **you do not need Dist::Zilla to contribute patches**. You do need | ||
Dist::Zilla to create a tarball. See below for guidance. | ||
|
||
### Getting dependencies | ||
|
||
If you have App::cpanminus 1.6 or later installed, you can use `cpanm` to | ||
satisfy dependencies like this: | ||
|
||
$ cpanm --installdeps . | ||
|
||
Otherwise, look for either a `Makefile.PL` or `cpanfile` file for | ||
a list of dependencies to satisfy. | ||
|
||
### Running tests | ||
|
||
You can run tests directly using the `prove` tool: | ||
|
||
$ prove -l | ||
$ prove -lv t/some_test_file.t | ||
|
||
For most of my distributions, `prove` is entirely sufficient for you to test any | ||
patches you have. I use `prove` for 99% of my testing during development. | ||
|
||
### Code style and tidying | ||
|
||
Please try to match any existing coding style. If there is a `.perltidyrc` | ||
file, please install Perl::Tidy and use perltidy before submitting patches. | ||
|
||
If there is a `tidyall.ini` file, you can also install Code::TidyAll and run | ||
`tidyall` on a file or `tidyall -a` to tidy all files. | ||
|
||
### Patching documentation | ||
|
||
Much of the documentation Pod is generated at release time. Some is | ||
generated boilerplate; other documentation is built from pseudo-POD | ||
directives in the source like C<=method> or C<=func>. | ||
|
||
If you would like to submit a documentation edit, please limit yourself to | ||
the documentation you see. | ||
|
||
If you see typos or documentation issues in the generated docs, please | ||
email or open a bug ticket instead of patching. | ||
|
||
### Where to send patches and pull requests | ||
|
||
If you found this distribution on Github, sending a pull-request is the | ||
best way to contribute. | ||
|
||
If a pull-request isn't possible, a bug ticket with a patch file is the | ||
next best option. | ||
|
||
As a last resort, an email to the author(s) is acceptable. | ||
|
||
## Installing and using Dist::Zilla | ||
|
||
Dist::Zilla is not required for contributing, but if you'd like to learn | ||
more, this section will get you up to speed. | ||
|
||
Dist::Zilla is a very powerful authoring tool, optimized for maintaining a | ||
large number of distributions with a high degree of automation, but it has a | ||
large dependency chain, a bit of a learning curve and requires a number of | ||
author-specific plugins. | ||
|
||
To install it from CPAN, I recommend one of the following approaches for | ||
the quickest installation: | ||
|
||
# using CPAN.pm, but bypassing non-functional pod tests | ||
$ cpan TAP::Harness::Restricted | ||
$ PERL_MM_USE_DEFAULT=1 HARNESS_CLASS=TAP::Harness::Restricted cpan Dist::Zilla | ||
|
||
# using cpanm, bypassing *all* tests | ||
$ cpanm -n Dist::Zilla | ||
|
||
In either case, it's probably going to take about 10 minutes. Go for a walk, | ||
go get a cup of your favorite beverage, take a bathroom break, or whatever. | ||
When you get back, Dist::Zilla should be ready for you. | ||
|
||
Then you need to install any plugins specific to this distribution: | ||
|
||
$ cpan `dzil authordeps` | ||
$ dzil authordeps | cpanm | ||
|
||
Once installed, here are some dzil commands you might try: | ||
|
||
$ dzil build | ||
$ dzil test | ||
$ dzil xtest | ||
|
||
You can learn more about Dist::Zilla at http://dzil.org/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
use strict; | ||
use warnings; | ||
|
||
use 5.010; | ||
|
||
use ExtUtils::MakeMaker 6.17; | ||
|
||
my %WriteMakefileArgs = ( | ||
"ABSTRACT" => "Iterative, recursive file finder", | ||
"AUTHOR" => "David Golden <dagolden\@cpan.org>", | ||
"CONFIGURE_REQUIRES" => { | ||
"ExtUtils::MakeMaker" => "6.17" | ||
}, | ||
"DISTNAME" => "Path-Iterator-Rule", | ||
"LICENSE" => "apache", | ||
"MIN_PERL_VERSION" => "5.010", | ||
"NAME" => "Path::Iterator::Rule", | ||
"PREREQ_PM" => { | ||
"Carp" => 0, | ||
"File::Basename" => 0, | ||
"File::Spec" => 0, | ||
"List::Util" => 0, | ||
"Number::Compare" => "0.02", | ||
"Scalar::Util" => 0, | ||
"Text::Glob" => 0, | ||
"Try::Tiny" => 0, | ||
"re" => 0, | ||
"strict" => 0, | ||
"warnings" => 0, | ||
"warnings::register" => 0 | ||
}, | ||
"TEST_REQUIRES" => { | ||
"Exporter" => 0, | ||
"ExtUtils::MakeMaker" => 0, | ||
"File::Spec" => 0, | ||
"File::Temp" => 0, | ||
"File::pushd" => 0, | ||
"Path::Tiny" => 0, | ||
"Test::Deep" => 0, | ||
"Test::Filename" => "0.03", | ||
"Test::More" => "0.92", | ||
"lib" => 0 | ||
}, | ||
"VERSION" => "1.009", | ||
"test" => { | ||
"TESTS" => "t/*.t" | ||
} | ||
); | ||
|
||
|
||
my %FallbackPrereqs = ( | ||
"Carp" => 0, | ||
"Exporter" => 0, | ||
"ExtUtils::MakeMaker" => 0, | ||
"File::Basename" => 0, | ||
"File::Spec" => 0, | ||
"File::Temp" => 0, | ||
"File::pushd" => 0, | ||
"List::Util" => 0, | ||
"Number::Compare" => "0.02", | ||
"Path::Tiny" => 0, | ||
"Scalar::Util" => 0, | ||
"Test::Deep" => 0, | ||
"Test::Filename" => "0.03", | ||
"Test::More" => "0.92", | ||
"Text::Glob" => 0, | ||
"Try::Tiny" => 0, | ||
"lib" => 0, | ||
"re" => 0, | ||
"strict" => 0, | ||
"warnings" => 0, | ||
"warnings::register" => 0 | ||
); | ||
|
||
|
||
unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { | ||
delete $WriteMakefileArgs{TEST_REQUIRES}; | ||
delete $WriteMakefileArgs{BUILD_REQUIRES}; | ||
$WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; | ||
} | ||
|
||
delete $WriteMakefileArgs{CONFIGURE_REQUIRES} | ||
unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; | ||
|
||
WriteMakefile(%WriteMakefileArgs); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
CONTRIBUTING | ||
CONTRIBUTING.mkdn |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters