From 3ad2b9bcdadf4de2f8a7a98c880010ead0020e91 Mon Sep 17 00:00:00 2001 From: Dustin Wheeler Date: Sat, 11 Jan 2014 23:39:52 -0500 Subject: [PATCH] Added documentation to CONTRIBUTING.md for using PHP Code Sniffer. --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69ae126..5f6bf84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,13 @@ We use the [PSR2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) standard. +[PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) is included as a Composer development requirement in order to help developers achieve PSR-2 compliance in any contributed code. + +### Running PHP CodeSniffer + +- Install PHP CodeSniffer by running composer with development requirements (`composer install --dev`). +- Execute `vendor/bin/phpcs --standard=psr2 src/Petrinet/*` from the project root directory + ## Unit tests ### Visualizing test cases