Visit github.com/sandrokeil/interop-config/ for the project website.
- Make sure you have execute
composer install
- Be sure you are in the root directory
If you wish to contribute to interop-config
, please be sure to read to the following resources:
- Coding Standards: PSR-0/1/2/4
- Git Guide: README-GIT.md
If you are working on new features, or refactoring an existing component, please create an issue first, so we can discuss it.
To run tests execute phpunit:
$ ./vendor/bin/phpunit
You can turn on conditional tests with the TestConfig.php file. To do so:
- Enter the
test/
subdirectory. - Copy
TestConfig.php.dist
file toTestConfig.php
- Edit
TestConfig.php
to enable any specific functionality you want to test, as well as to provide test values to utilize.
To check coding standards execute phpcs:
$ ./vendor/bin/phpcs
To auto fix coding standard issues execute:
$ ./vendor/bin/phpcbf
To run benchmarks execute phpbench:
$ ./vendor/bin/phpbench run --report=aggregate
To generate the documentation execute bookdown:
$ ./vendor/bin/bookdown doc/bookdown.json
For every program above there are shortcuts defined in the composer.json
file.
check
: Executes PHPCodeSniffer and PHPUnitcs
: Executes PHPCodeSniffercs-fix
: Executes PHPCodeSniffer and auto fixes issuestest
: Executes PHPUnittest-coverage
: Executes PHPUnit with code coveragedocs
: Generates awesome Bookdown.io docsbenchmark
: Executes PHPBench