65 lines (45 loc) · 977 Bytes

Contributing

Introduction

You need several applications to be able to contribute, run tests, lint and format the code

Perl interpreter (using perlbrew)
cpanm
modules to build the package
modules to run tests
modules to run perlcritic and perltidy

Setup

Install perlbrew on your system (https://perlbrew.pl/)
Init the perlbrew (only once if you didn't have it before)

    $ perlbrew init

Install perl and all necessary modules to a separate library

    $ source dev.rc

Developing

Prepare your shell by running:

    $ source dev.rc

Testing

Running perltidy and perlcritic for all files

    $ make tidy

Run only unit tests

    $ make unit-test

Run unit and author tests

    $ make author-test

Run all possible tests before release

    $ make release-test

Releasing

Prepare release archive

    $ make build