File Coverage

blib/lib/Task/BeLike/FIBO.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

package Task::BeLike::FIBO;
use strict;
use warnings;
our $VERSION = '0.8';
1;

=encoding utf8

=head1 NAME

Task::BeLike::FIBO -- Leonardo Pisano a.k.a. Fibonacci

=head1 SYNOPSIS

    cpan Task::BeLike::FIBO
    perldoc Task::BeLike::FIBO

=head1 DESCRIPTION

Hi! I am L<FIBO|https://metacpan.org/author/FIBO> an italian mathematician. I graduated in 2005 at L<Università degli Studi di Genova|http://www.dima.unige.it/> and since then I work doing Business Intelligence and Web Analytics. My boss said: you need Perl. So I started using this language. I like many programming languages, but, Perl really help me to pay my rent.

This is a primary about my habits and a collection of modules I use when I write Perl code.

=head1 PACKAGE GUIDELINES

Do not get crazy with automatic generators. I am a mathematician and a coder, not a corporation.
Every package is different and has different needings. The followings are samples for files I usually need in a package.

Just use copy and paste and your brain!

The smack of a L<DRY|http://en.wikipedia.org/wiki/Don't_repeat_yourself> L<KISS|http://en.wikipedia.org/wiki/KISS_principle> is not that bad.

Learn from nature: stay as minimal as possible.

=head2 FILES

Follows a list of sample files of a package, C<MY::Package> for instance.

=over 4

=item *

README.md

    My-Package
    ==========

    My-Package description ...

    To install, pray the mantra

        perl Makefile.PL
        make
        make test
        make install

    For more information point your browser to [online docs](https://metacpan.org/pod/My::Package)

    --------
    [![CPAN version](https://badge.fury.io/pl/My-Package-pm.svg)](https://metacpan.org/pod/My::Package)
    [![Build Status](https://travis-ci.org/fibo/My-Package-pm.png?branch=master)](https://travis-ci.org/fibo/My-Package-pm)
    [![Coverage Status](https://coveralls.io/repos/fibo/My-Package-pm/badge.png?branch=master)](https://coveralls.io/r/fibo/My-Package-pm?branch=master)

=item *

.travis.yml

    language: perl
    perl:
      - "5.18"
      - "5.16"
      - "5.14"
      - "5.12"
      - "5.10"
      - "5.8"

=item *

.gitignore

    .*
    *~
    !.gitignore
    !.travis.yml
    blib
    pm_to_blib
    Makefile*
    !Makefile.PL
    MANIFEST*
    !MANIFEST.SKIP
    *META.*
    *.tar.gz

=item *

Makefile.PL

    use strict;
    use warnings;

    use ExtUtils::MakeMaker 6.64;

    WriteMakefile(
        ABSTRACT_FROM => 'lib/My/Package.pm',
        VERSION_FROM  => 'lib/My/Package.pm',
        AUTHOR        => 'G. Casati <[e-mail]>',
        NAME          => 'My::Package',
        META_MERGE => {
          resources => {
            homepage   => 'https://metacpan.org/pod/My::Package'
            license    => 'http://g14n.info/mit-license',
            repository => 'http://github.com/fibo/My-Package-pm',
            bugtracker => 'http://github.com/fibo/My-Package-pm/issues',
        },
        PREREQ_PM => {
            # 'Some::Package' => '0',
            # 'Other::Package' => '1.2.3',
        },
        test => { TESTS => 't/*.t' },
        TEST_REQUIRES => {
            'Test::Compile' => '1',
            'Test::More' => '1',
            'Test::Pod'  => '1',
        }
    );

=item *

MANIFEST.SKIP

    ^MANIFEST\.SKIP$
    ^MANIFEST\.bak$
    ^\.
    .*\.old$
    .*\.bak$
    \.tar\.gz$
    ^Makefile$
    ^MYMETA\.
    ^blib
    ^pm_to_blib

=back

=head2 WORKFLOW

=over 4

=item *

Start a feature branch

    git checkout -b somefeature

=item *

Write documentation about new feature. Then write tests to check it and code to implement it.

=item *

Run tests

    prove -l --state=save

=item *

If some test does not pass, fix code and run tests that failed

    prove -l --state=save,failed

=item *

Merge feature branch and commit work

    git rebase master
    git checkout master
    git merge somefeature
    git push

=item *

Update version, use L<Semantic Versioning|http://semver.org/>.

Create a new release

    perl Makefile.PL
    make
    make test
    make manifest
    make dist
    make realclean

=item *

Upload to L<PAUSE|http://pause.perl.org/>

    cpan-upload -u fibo My-Package-0.1.tar.gz

=back


=head1 STUFF INCLUDED

=over 4

=item *

L<CPAN>

See how to setup L<A CPAN client that works like a charm|http://g14n.info/2014/03/a-cpan-client-that-works-like-charm>.

=item *

L<CPAN::Uploader>

=item *

L<ExtUtils::MakeMaker> version C<6.64>, cause I use the C<TEST_REQUIRES> option.

=item *

L<Perl::Tidy>

Use L<Perl::Tidy> defaults. Do not indent every source file automatically, indent by hand and use your creativity.

See Perl section in L<My Vim preferences|http://g14n.info/2013/07/my-vim-configuration#perl> to see how you can use L<perltidy> with Vim.

=item *

L<Test::Compile>

Create a C<t/_compile.t> file

    use strict;
    use warnings;
    use Test::More;

    eval "use Test::Compile";
    Test::More->builder->BAIL_OUT(<<EOF) if $@;
    Test::Compile required for testing compilation
    EOF

    all_pm_files_ok();

=item *

L<Test::More>

=item *

L<Test::Pod>

Create a C<t/_pod.t> file

    use strict;
    use warnings;
    use Test::More;

    eval "use Test::Pod";
    Test::More->builder->BAIL_OUT(<<EOF) if $@;
    Test::Pod required for testing compilation
    EOF

    all_pod_files_ok();

=back

=cut