Contributing

This is for people who want to contribute to the project.

How to get started

First of all, you need to fork the repository and clone it locally. After that, we've prepared a docker setup to help you get started quickly.

Install docker and docker-compose on your machine, then run the following commands:

docker-compose up --detach

Install the dependencies with composer:

docker-compose exec php-fpm composer install

Install the lowest dependencies with composer:

docker-compose exec php-fpm composer update --prefer-lowest

Now you can execute the tests with the following command:

docker-compose exec php-fpm ./vendor/bin/phpunit --process-isolation

If one test fails, run it without the --process-isolation option

docker-compose exec php-fpm ./vendor/bin/phpunit tests/Test/ConfigMongodbTest.php

You can also use the --filter option to run tests matching a class and name:

docker-compose exec php-fpm ./vendor/bin/phpunit --process-isolation --filter=ConfigSqliteTest::testAppendFixtures

You can also use the --filter option to run tests matching a name:

docker-compose exec php-fpm ./vendor/bin/phpunit --process-isolation --filter=testAppendFixtures

If you change the version of PHP or dependencies, the caches may cause issues, they can be deleted:

docker-compose exec php-fpm bash -c "rm -rf tests/App*/var/cache/*"