This is an automated email from the git hooks/post-receive script. js pushed a commit to annotated tag release-0.004 in repository libmoox-role-logger-perl.
commit dc4412c170c3dbe334cacf18b638b0f72582381c Author: David Golden <dagol...@cpan.org> Date: Thu Sep 18 10:25:57 2014 -0400 update repo meta files --- CONTRIBUTING | 50 --------------------------- CONTRIBUTING.mkdn | 100 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.mkdn | 2 +- perlcritic.rc | 3 ++ 4 files changed, 104 insertions(+), 51 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index aeb58e6..0000000 --- a/CONTRIBUTING +++ /dev/null @@ -1,50 +0,0 @@ -CONTRIBUTING - -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 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: - - $ prove -l - $ prove -lv t/some_test_file.t - -For most distributions, 'prove' is entirely sufficent for you to test any -patches you have. - -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: - - $ mymeta-requires | cpanm - $ cpan `mymeta-requires` - -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. - -If you see typos or documentation issues in the generated docs, please -email or open a bug ticket instead of patching. - -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 - -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/ - diff --git a/CONTRIBUTING.mkdn b/CONTRIBUTING.mkdn new file mode 100644 index 0000000..f50a30d --- /dev/null +++ b/CONTRIBUTING.mkdn @@ -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 than many of the +usual files you might expect are not in the repository, but are generated at +release time (e.g. Makefile.PL). + +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. + +### 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: + + $ 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` + +### 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. Depending on the +distribution, some of my 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. + +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 +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 + +To install from the repository, use: + + $ dzil install + +You can learn more about Dist::Zilla at http://dzil.org/ + diff --git a/README.mkdn b/README.mkdn index 73dfc33..0b0ab43 120000 --- a/README.mkdn +++ b/README.mkdn @@ -1 +1 @@ -CONTRIBUTING \ No newline at end of file +CONTRIBUTING.mkdn \ No newline at end of file diff --git a/perlcritic.rc b/perlcritic.rc index cef05a8..bcbbb45 100644 --- a/perlcritic.rc +++ b/perlcritic.rc @@ -7,6 +7,9 @@ allow = $@ $! [TestingAndDebugging::ProhibitNoStrict] allow = refs +[Variables::ProhibitEvilVariables] +variables = $DB::single + # Turn these off [-BuiltinFunctions::ProhibitStringyEval] [-ControlStructures::ProhibitPostfixControls] -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libmoox-role-logger-perl.git _______________________________________________ Pkg-perl-cvs-commits mailing list Pkgfirstname.lastname@example.org http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-perl-cvs-commits