Skip to content

Commit fa87a8d

Browse files
committed
fix repo meta files
1 parent 5e90b47 commit fa87a8d

File tree

3 files changed

+18
-91
lines changed

3 files changed

+18
-91
lines changed

CONTRIBUTING renamed to CONTRIBUTING.mkdn

Lines changed: 17 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,21 @@ contains instructions that will help you work with the source code.
55

66
The distribution is managed with Dist::Zilla. This means than many of the
77
usual files you might expect are not in the repository, but are generated at
8-
release time (e.g. Makefile.PL).
8+
release time, as is much of the documentation. Some generated files are
9+
kept in the repository as a convenience (e.g. Makefile.PL or cpanfile).
910

1011
Generally, **you do not need Dist::Zilla to contribute patches**. You do need
11-
Dist::Zilla to create a tarball and/or install from the repository. See below
12-
for guidance.
13-
14-
### Acceptable contributions
15-
16-
HTTP::Tiny is considered nearly feature-complete. The only features likely to
17-
be added are those that improve compliance with RFC 2616. If you have ideas
18-
for other features, please look at
19-
[HTTP::Tiny::UA](http://p3rl.org/HTTP::Tiny::UA/) and consider adding your
20-
feature there.
21-
22-
Bug fixes and performance improvements that do not bloat the code will be
23-
considered for inclusion.
12+
Dist::Zilla to create a tarball. See below for guidance.
2413

2514
### Getting dependencies
2615

27-
See the included `cpanfile` file for a list of dependencies. If you have
28-
App::cpanminus 1.6 or later installed, you can use `cpanm` to satisfy
29-
dependencies like this:
16+
If you have App::cpanminus 1.6 or later installed, you can use `cpanm` to
17+
satisfy dependencies like this:
3018

3119
$ cpanm --installdeps .
3220

33-
Otherwise, you can install Module::CPANfile 1.0002 or later and then satisfy
34-
dependencies with the regular `cpan` client and `cpanfile-dump`:
35-
36-
$ cpan `cpanfile-dump`
21+
Otherwise, look for either a `Makefile.PL` or `cpanfile` file for
22+
a list of dependencies to satisfy.
3723

3824
### Running tests
3925

@@ -47,24 +33,24 @@ patches you have. I use `prove` for 99% of my testing during development.
4733

4834
### Code style and tidying
4935

50-
Please try to match any existing coding style.
36+
Please try to match any existing coding style. If there is a `.perltidyrc`
37+
file, please install Perl::Tidy and use perltidy before submitting patches.
38+
39+
If there is a `tidyall.ini` file, you can also install Code::TidyAll and run
40+
`tidyall` on a file or `tidyall -a` to tidy all files.
5141

5242
### Patching documentation
5343

54-
Much of the documentation Pod is generated at release time.
44+
Much of the documentation Pod is generated at release time. Some is
45+
generated boilerplate; other documentation is built from pseudo-POD
46+
directives in the source like C<=method> or C<=func>.
5547

56-
If you would like to submit a documentation edit, please limit yourself to the
57-
documentation you see.
48+
If you would like to submit a documentation edit, please limit yourself to
49+
the documentation you see.
5850

5951
If you see typos or documentation issues in the generated docs, please
6052
email or open a bug ticket instead of patching.
6153

62-
### Installing from the repository
63-
64-
If you want to install directly from the repository, you need to have
65-
Dist::Zilla installed (see below). If this is a burden to you, I welcome
66-
patches against a CPAN tarball instead of the repository.
67-
6854
### Installing and using Dist::Zilla
6955

7056
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:
9783
$ dzil test
9884
$ dzil xtest
9985

100-
To install from the repository, use:
101-
102-
$ dzil install
103-
10486
You can learn more about Dist::Zilla at http://dzil.org/
10587

README.mkdn

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
CONTRIBUTING
1+
CONTRIBUTING.mkdn

cpanfile

Lines changed: 0 additions & 55 deletions
This file was deleted.

0 commit comments

Comments
 (0)