# To read this file, run:
#    perldoc CONTRIBUTING.pod

=head1 CONTRIBUTING

How to contribute to C<GDPR-IAB-TCFv2>?

=head1 DESCRIPTION

Patches are welcome!

They must be built against the
C<L<devel|https://github.com/peczenyj/GDPR-IAB-TCFv2/tree/devel>> branch,
then submitted as pull requests at GitHub.

The documentation is written using the
L<POD|http://perldoc.perl.org/perlpod.html> format. Use the C<perldoc> tool
to render it in a terminal:

    perldoc CONTRIBUTING.pod

=head1 PATCHING, STEP BY STEP

=over 4

=item 1. Get the source

    git clone --origin upstream git://github.com/peczenyj/GDPR-IAB-TCFv2.git
    cd GDPR-IAB-TCFv2
    git checkout devel

=item 2. Install build dependencies

Not required for doc patches.

    curl -L https://cpanmin.us | perl - --installdeps --with-develop .

=item 3. Make your fix/feature

    git checkout -b <my-patch> devel

    # edit files and add modification

    # Run the testsuite
    prove -v

    git commit -s -m '<<some nice message>>'

=item 4. Setup a fork

=item 4.1. L<Fork the project on GitHub|https://github.com/peczenyj/GDPR-IAB-TCFv2/>

=item 4.2. Link your local repo to your fork (just once)

(You are using C<GDPR-IAB-TCFv2> isn't it?)

    git remote add github <github-user>.github.com:<github-user>/GDPR-IAB-TCFv2.git

=item 5. Submit your work

=item 5.1 Push!

    git push github <my-patch>

=item 5.2 Submit a pull request on GitHub

=item 6. Loop

Redo from step 3.

=back

=head1 FOR RELEASE MANAGER

=over 4

=item * Bump C<$VERSION>

    git checkout devel
    # Bump version number
    $EDITOR lib/GDPR/IAB/TCFv2.pm
    # Update changelog
    git cliff -o CHANGELOG.md
    # update readme
    pod2markdown lib/GDPR/IAB/TCFv2.pm > README.md
    git add .
    git commit

=item * Release

    git checkout devel
    perl Makefile.PL
    make
    make test
    make dist
    ...

=back

=cut
