Contributions are encouraged and welcome; we are always happy to get feedback or pull requests on GitHub.
When contributing there are a few guidelines we'd like you to keep in mind:
-
PSR-12 Coding Standard Please use the following command after you have completed your work:
$ composer format
This will check/correct all the code for the PSR-12 Coding Standard using the wonderful php-cs-fixer.
-
Add unit tests! - Your Pull Request won't be accepted if it does not have tests:
- Ensure your new Holiday Provider contains all the necessary unit tests.
- Next to the file 'BaseTestCase.php', a file called 'Test.php' needs to be present. This file needs to include region/country level tests and requires assertion of all expected holidays.
- All the unit tests and the implementation Holiday Provider require to have the correct locale, timezone and region/country name.
- As almost all tests use automatic iterations, make sure the year for which the test is executed is a valid year. Some holidays are only established from a certain year and having the test year number smaller than the minimum establishment year (amongst all holidays) can result in false errors.
-
Document any change - Make sure the
README.md
and any other relevant documentation are kept up-to-date. -
One pull request per feature - If you want to contribute more than one thing, send multiple pull requests.
-
Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
$ composer test
or alternatively run with:
$ vendor/bin/phpunit