Skip to content

Commit c6d66aa

Browse files
committed
Updated CONTRIBUTING.md (composer scripts)
1 parent 97369f2 commit c6d66aa

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,26 +53,28 @@ $ composer install
5353
To run tests, use the PHPUnit executable installed by Composer:
5454

5555
```console
56-
$ ./vendor/bin/phpunit
56+
$ composer test
5757
```
5858

5959
## CODING STANDARDS
6060

6161
While Apigility uses Zend Framework 2 coding standards, in practice, we check
62-
standards using [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) (which is
63-
installed via Composer with other dependencies). To check for CS issues:
62+
standards against PSR-1/2. To check for CS issues:
6463

6564
```console
66-
$ ./vendor/bin/php-cs-fixer fix . --dry-run
65+
$ composer cs-check
6766
```
6867

69-
This will report CS issues. Alternately, you can have the tool fix them for you
70-
by omitting the `--dry-run` switch:
68+
This will report CS issues. You can also attempt to fix many reported errors
69+
automatically:
7170

7271
```console
73-
$ ./vendor/bin/php-cs-fixer fix .
72+
$ composer cs-fix
7473
```
7574

75+
If you use `cs-fix` to fix issues, make certain you add and commit any files
76+
changed!
77+
7678
## Conduct
7779

7880
Please see our [CONDUCT.md](CONDUCT.md) to understand expected behavior when interacting with others in the project.

0 commit comments

Comments
 (0)