43 lines
889 B
Markdown
43 lines
889 B
Markdown
|
Contributing
|
||
|
|
============
|
||
|
|
|
||
|
|
When contributing, you can fix some things that will be detected by CI anyway *before* sending your pull request.
|
||
|
|
|
||
|
|
The following tools will be installed in the `tools` directory, so they don't share the bundle requirements.
|
||
|
|
|
||
|
|
PHPStan
|
||
|
|
-------
|
||
|
|
|
||
|
|
```bash
|
||
|
|
composer install --working-dir=tools/phpstan
|
||
|
|
tools/phpstan/vendor/bin/phpstan analyze
|
||
|
|
# Based on the results, you may want to update the baseline
|
||
|
|
tools/phpstan/vendor/bin/phpstan analyze --generate-baseline
|
||
|
|
```
|
||
|
|
|
||
|
|
PHP CS Fixer
|
||
|
|
------------
|
||
|
|
|
||
|
|
```bash
|
||
|
|
composer install --working-dir=tools/php-cs-fixer
|
||
|
|
# Check what can be fixed
|
||
|
|
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff
|
||
|
|
# Fix them
|
||
|
|
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --diff
|
||
|
|
```
|
||
|
|
|
||
|
|
Psalm
|
||
|
|
-----
|
||
|
|
|
||
|
|
```bash
|
||
|
|
composer install --working-dir=tools/psalm
|
||
|
|
tools/psalm/vendor/bin/psalm
|
||
|
|
```
|
||
|
|
|
||
|
|
PHPUnit
|
||
|
|
-------
|
||
|
|
|
||
|
|
```bash
|
||
|
|
./vendor/bin/simple-phpunit
|
||
|
|
```
|