Commit fa87a8d8 authored by David Golden's avatar David Golden

fix repo meta files

parent 5e90b474
......@@ -5,35 +5,21 @@ contains instructions that will help you work with the source code.
The distribution is managed with Dist::Zilla. This means than many of the
usual files you might expect are not in the repository, but are generated at
release time (e.g. Makefile.PL).
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 and/or install from the repository. See below
for guidance.
### Acceptable contributions
HTTP::Tiny is considered nearly feature-complete. The only features likely to
be added are those that improve compliance with RFC 2616. If you have ideas
for other features, please look at
[HTTP::Tiny::UA](http://p3rl.org/HTTP::Tiny::UA/) and consider adding your
feature there.
Bug fixes and performance improvements that do not bloat the code will be
considered for inclusion.
Dist::Zilla to create a tarball. See below for guidance.
### Getting dependencies
See the included `cpanfile` file for a list of dependencies. If you have
App::cpanminus 1.6 or later installed, you can use `cpanm` to satisfy
dependencies like this:
If you have App::cpanminus 1.6 or later installed, you can use `cpanm` to
satisfy dependencies like this:
$ cpanm --installdeps .
Otherwise, you can install Module::CPANfile 1.0002 or later and then satisfy
dependencies with the regular `cpan` client and `cpanfile-dump`:
$ cpan `cpanfile-dump`
Otherwise, look for either a `Makefile.PL` or `cpanfile` file for
a list of dependencies to satisfy.
### Running tests
......@@ -47,24 +33,24 @@ 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.
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.
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 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.
### Installing from the repository
If you want to install directly from the repository, you need to have
Dist::Zilla installed (see below). If this is a burden to you, I welcome
patches against a CPAN tarball instead of the repository.
### Installing and using Dist::Zilla
Dist::Zilla is a very powerful authoring tool, optimized for maintaining a
......@@ -97,9 +83,5 @@ Once installed, here are some dzil commands you might try:
$ dzil test
$ dzil xtest
To install from the repository, use:
$ dzil install
You can learn more about Dist::Zilla at http://dzil.org/
CONTRIBUTING
\ No newline at end of file
CONTRIBUTING.mkdn
\ No newline at end of file
requires "Carp" => "0";
requires "Fcntl" => "0";
requires "IO::Socket" => "0";
requires "MIME::Base64" => "0";
requires "Time::Local" => "0";
requires "bytes" => "0";
requires "perl" => "5.006";
requires "strict" => "0";
requires "warnings" => "0";
recommends "HTTP::CookieJar" => "0.001";
recommends "IO::Socket::IP" => "0.25";
recommends "IO::Socket::SSL" => "1.42";
recommends "Mozilla::CA" => "20130114";
recommends "Net::SSLeay" => "1.49";
suggests "IO::Socket::SSL" => "1.56";
on 'test' => sub {
requires "Data::Dumper" => "0";
requires "Exporter" => "0";
requires "ExtUtils::MakeMaker" => "0";
requires "File::Basename" => "0";
requires "File::Spec" => "0";
requires "File::Temp" => "0";
requires "IO::Dir" => "0";
requires "IO::File" => "0";
requires "IO::Socket::INET" => "0";
requires "IPC::Cmd" => "0";
requires "Test::More" => "0.96";
requires "open" => "0";
};
on 'test' => sub {
recommends "CPAN::Meta" => "2.120900";
};
on 'configure' => sub {
requires "ExtUtils::MakeMaker" => "6.17";
};
on 'develop' => sub {
requires "Dist::Zilla" => "5";
requires "Dist::Zilla::Plugin::Prereqs" => "0";
requires "Dist::Zilla::Plugin::RemovePrereqs" => "0";
requires "Dist::Zilla::PluginBundle::DAGOLDEN" => "0.068";
requires "File::Spec" => "0";
requires "File::Temp" => "0";
requires "IO::Handle" => "0";
requires "IPC::Open3" => "0";
requires "Pod::Coverage::TrustPod" => "0";
requires "Test::CPAN::Meta" => "0";
requires "Test::More" => "0";
requires "Test::Pod" => "1.41";
requires "Test::Pod::Coverage" => "1.08";
requires "Test::Spelling" => "0.12";
};
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment