diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e432c1fe..db4023af 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -21,12 +21,12 @@ Install GrumPHP globally or in the progpilot repository: ```shell composer install --dev phpro/grumphp ``` -Install the [required tasks](../grumphp.yml) for progpilot. +Install the [required tasks](../grumphp.yml) for Progpilot: ```shell composer install --dev squizlabs/php_codesniffer composer install --dev designsecurity/progpilot ``` -In your shell configure the following environment variable to instruct where GrumPHP can locate progpilot and phpcs executables: +Configure the following env variable to instruct GrumPHP where it should locate tasks executables: ```shell export GRUMPHP_BIN_DIR="/path/to/vendor/bin" ``` diff --git a/docs/DEV.md b/docs/DEV.md index ffbfe063..aa64d57e 100644 --- a/docs/DEV.md +++ b/docs/DEV.md @@ -10,7 +10,7 @@ This project would not have been possible without these dependencies : ## Tests We are using more than 2400 tests cases from [PHP Vulnerability test suite](https://github.com/stivalet/PHP-Vulnerability-test-suite) for testing our tool. -To run the tests suite go to ./projects/tests folder and execute phpunit +To run the tests suite go to [./projects/tests](../projects/tests/) folder and execute [phpunit](https://phpunit.de/). ## License