First of all, thank you for contributing, you are awesome!
Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work.
You MUST follow the PSR-1 and PSR-2. If you don't know about any of them, you should really read the recommendations. Can't wait? Use the PHP-CS-Fixer tool.
You MUST run the test suite.
You MUST write (or update) unit tests.
You SHOULD write documentation.
Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.
One may ask you to squash your
commits
too. This is used to "clean" your Pull Request before merging it (we don't want
commits such as fix tests, fix 2, fix 3, etc.).
Thank you!
Tests suite uses Docker environments in order to be idempotent to OS's. More than this PHP version is written inside the Dockerfile; this assures to test the bundle with the same resources. No need to have PHP or Mongo installed.
You only need Docker set it up.
To allow testing environments more smooth we implemented Makefile. You have two commands available:
make testswhich will execute all tests inside the docker.
make test TEST="Tests/Util/FilenameUtilsTest.php"will allow testing single Test Classes.
There are three environments available: PHP 8.1, PHP 8.2, and PHP 8.3. Default environment is PHP 8.1. If you want to execute it against other PHP versions, please use environment variables as this:
make tests #PHP 8.1 env
TARGET=82 make tests #PHP 8.2 env
make test TEST="tests/Util/FilenameUtilsTest.php" #PHP 8.1 env
TARGET=82 make test TEST="tests/Util/FilenameUtilsTest.php" #PHP 8.2 env