[libclass-tiny-perl] 02/07: update CONTRIBUTING

[gregor herrmann]

This is an automated email from the git hooks/post-receive script.

gregoa pushed a commit to annotated tag release-0.008
in repository libclass-tiny-perl.

commit a085a1a8b26197dd7e032819ff3fddec1107b233
Author: David Golden <dagolden at cpan.org>
Date:   Sat Sep 7 17:05:08 2013 -0400

    update CONTRIBUTING
---
 CONTRIBUTING | 52 ++++++++++++++++++++++++++++++++--------------------
 1 file changed, 32 insertions(+), 20 deletions(-)

diff --git a/CONTRIBUTING b/CONTRIBUTING
index aeb58e6..bb3d23d 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -1,4 +1,4 @@
-CONTRIBUTING
+## HOW TO CONTRIBUTE
 
 Thank you for considering contributing to this distribution.  This file
 contains instructions that will help you work with the source code.
@@ -7,44 +7,56 @@ 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).
 
-However, you can run tests directly using the 'prove' tool:
+### Getting dependencies
 
-  $ prove -l
-  $ prove -lv t/some_test_file.t
+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:
 
-For most distributions, 'prove' is entirely sufficent for you to test any
-patches you have.
+    $ 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`
 
-You may need to satisfy some dependencies.  See the included META.json
-file for a list.  If you install App::mymeta_requires from CPAN, it's easy
-to satisfy any that you are missing by piping the output to your favorite
-CPAN client:
+### Running tests
 
-  $ mymeta-requires | cpanm
-  $ cpan `mymeta-requires`
+You can run tests directly using the `prove` tool:
+
+    $ prove -l
+    $ prove -lv t/some_test_file.t
+
+For most distributions, `prove` is entirely sufficent for you to test any
+patches you have.
+
+### Patching documentation
 
 Likewise, much of the documentation Pod is generated at release time.
 Depending on the distribution, some documentation may be written in a Pod
-dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) If you would like to
-submit a documentation edit, please limit yourself to the documentation you
-see.
+dialect called WikiDoc. (See Pod::WikiDoc on CPAN.)
+
+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.
 
+### Learning Dist::Zilla
+
 Dist::Zilla is a very powerful authoring tool, but requires a number of
 author-specific plugins.  If you would like to use it for contributing,
 install it from CPAN, then run one of the following commands, depending on
 your CPAN client:
 
-  $ cpan `dzil authordeps`
-  $ dzil authordeps | cpanm
+    $ cpan `dzil authordeps`
+    $ dzil authordeps | cpanm
 
 Once installed, here are some dzil commands you might try:
 
-  $ dzil build
-  $ dzil test
-  $ dzil xtest
+    $ dzil build
+    $ dzil test
+    $ dzil xtest
 
 You can learn more about Dist::Zilla at http://dzil.org/
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libclass-tiny-perl.git