Skip to content

Commit

Permalink
Add CodeSniffer in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroendesloovere committed Mar 29, 2018
1 parent 31e9352 commit 4c730d0
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,19 @@ We have tests to make sure everything works as expected.
First execute `composer install`.
Then execute `vendor/bin/phpunit tests`.

### Coding Syntax

We use [squizlabs/php_codesniffer](https://packagist.org/packages/squizlabs/php_codesniffer) to maintain the code standards.
Type the following to execute them:
```bash
# To view the code errors
vendor/bin/phpcs --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"

# OR to fix the code errors
vendor/bin/phpcbf --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"
```
> [Read documentation about the code standards](https://github.com/squizlabs/PHP_CodeSniffer/wiki)
## Documentation

The class is well documented inline. If you use a decent IDE you'll see that each method is documented with PHPDoc.
Expand Down

0 comments on commit 4c730d0

Please sign in to comment.