Skip to content

Commit

Permalink
minor #188 Improve CONTRIBUTING.md & Psalm config (jmsche)
Browse files Browse the repository at this point in the history
This PR was squashed before being merged into the main branch.

Discussion
----------

Improve CONTRIBUTING.md & Psalm config

Commits
-------

e3ffc94 Improve CONTRIBUTING.md & Psalm config
  • Loading branch information
weaverryan committed Jul 13, 2022
2 parents c1ceaa8 + e3ffc94 commit f64540b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/static.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 12 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -16,7 +16,7 @@ tools/phpstan/vendor/bin/phpstan analyze --generate-baseline
```

PHP CS Fixer
============
------------

```bash
composer install --working-dir=tools/php-cs-fixer
Expand All @@ -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
```
1 change: 1 addition & 0 deletions psalm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
>
<projectFiles>
<directory name="src" />
Expand Down

0 comments on commit f64540b

Please sign in to comment.