Contributing

This document describes various tools used during development of this library.

Install

To install the dependencies required for the development and usage of this library, run composer install through the supplied docker compose setup.

docker compose run --rm phpfpm composer install

We use the PHPUnit testing framework.

To run tests execute the following command:

docker compose run --rm phpfpm vendor/bin/phpunit --coverage-clover=coverage/unit.xml

The following commands let you test that the code follows the coding standards we decided to adhere to in this project.

docker compose run --rm phpfpm composer coding-standards-check

docker compose run --rm node yarn install
docker compose run --rm node yarn run coding-standards-check

You can automatically fix some coding styles issues by running:

docker compose run --rm phpfpm composer coding-standards-apply