CONTRIBUTING

How to contribute to GDPR-IAB-TCFv2?

DESCRIPTION

Patches are welcome!

They must be built against the main branch, then submitted as pull requests at GitHub.

The documentation is written using the POD format. Use the perldoc tool to render it in a terminal:

perldoc CONTRIBUTING.pod

PATCHING, STEP BY STEP

1. Get the source

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

2. Install build dependencies

Not required for doc patches.

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

3. Make your fix/feature

git checkout -b <my-patch> main

# edit files and add modification

# Run the testsuite
prove -v

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

4. Setup a fork

4.1. Fork the project on GitHub

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

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

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

5. Submit your work

5.1 Push!

git push github <my-patch>

5.2 Submit a pull request on GitHub

6. Loop

Redo from step 3.

FOR RELEASE MANAGER

• Bump $VERSION

  git checkout main
  # Bump version number
  $EDITOR lib/GDPR/IAB/TCFv2.pm
  # Update changelog
  $EDITOR Changes
  # update readme
  pod2markdown lib/GDPR/IAB/TCFv2.pm > README.md
  git add .
  git commit

• Release

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