From e3ffc9489489ceebf8641a44ef651dbf67bae518 Mon Sep 17 00:00:00 2001 From: jmsche Date: Thu, 7 Jul 2022 15:04:03 +0200 Subject: [PATCH] Improve CONTRIBUTING.md & Psalm config --- .github/workflows/static.yml | 2 +- CONTRIBUTING.md | 17 ++++++++++++----- psalm.xml | 1 + 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml index 66e00e8c..68746b66 100644 --- a/.github/workflows/static.yml +++ b/.github/workflows/static.yml @@ -74,7 +74,7 @@ jobs: composer-options: "--working-dir=tools/psalm" - name: Psalm - run: tools/psalm/vendor/bin/psalm --no-progress --php-version=8.0 + run: tools/psalm/vendor/bin/psalm --no-progress composer-normalize: name: Composer Normalize diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a586d118..699ec4fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ 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 @@ -16,7 +16,7 @@ tools/phpstan/vendor/bin/phpstan analyze --generate-baseline ``` PHP CS Fixer -============ +------------ ```bash composer install --working-dir=tools/php-cs-fixer @@ -27,9 +27,16 @@ tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --diff ``` Psalm -===== +----- ```bash composer install --working-dir=tools/psalm -tools/psalm/vendor/bin/psalm --php-version=8.0 +tools/psalm/vendor/bin/psalm +``` + +PHPUnit +------- + +```bash +./vendor/bin/simple-phpunit ``` diff --git a/psalm.xml b/psalm.xml index e044bd6b..f0acd22c 100644 --- a/psalm.xml +++ b/psalm.xml @@ -6,6 +6,7 @@ xmlns="https://getpsalm.org/schema/config" xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd" errorBaseline="psalm.baseline.xml" + phpVersion="8.0" >