Added documentation to CONTRIBUTING.md for using PHP Code Sniffer.

florianv · Jan 12, 2014 · 3ad2b9b · 3ad2b9b
1 parent 480fb3a
commit 3ad2b9b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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