diff --git a/Coding-style-policy.md b/Coding-style-policy.md index 2a31a72..01bad09 100644 --- a/Coding-style-policy.md +++ b/Coding-style-policy.md @@ -2,6 +2,13 @@ This page explains the coding style policy for RSS-Bridge with examples and refe RSS-Bridge uses [Travis-CI](https://travis-ci.org/) to validate code quality. You will automatically be notified if issues were found in your pull request. You must fix those issues before the pull request will be merged. Refer to [phpcs.xml](https://github.com/RSS-Bridge/rss-bridge/blob/master/phpcs.xml) for a complete list of policies enforced by Travis-CI. +If you want to run the checks locally, make sure you have [`phpcs`](https://github.com/squizlabs/PHP_CodeSniffer) and [`phpunit`](https://phpunit.de/) installed on your machine and run following commands in the root directory of RSS-Bridge (tested on Debian): + +```console +phpcs . --standard=phpcs.xml --warning-severity=0 --extensions=php -p +phpunit --configuration=phpunit.xml --include-path=lib/ +``` + # Use tabs for indentation RSS-Bridge uses tabs for indentation on all PHP files in the repository (except files located in the `vendor` directory)