Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eric-therond committed Feb 27, 2020
1 parent 79bc0bd commit 3701cb2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
16 changes: 16 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,22 @@ That will allow the ability of contributors to reproduce the bug.
### Style
All php code must adhere to [PSR-2 standard](https://www.php-fig.org/psr/psr-2/) (except for tests).

### GrumPHP
Progpilot can use [GrumPHP](https://github.com/phpro/grumphp/) to ensure each commit reaches code style (phpcs) and security (progpilot itself) requirements.
Install GrumPHP globally or in the progpilot repository:
```shell
composer install --dev phpro/grumphp
```
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:
```shell
export GRUMPHP_BIN_DIR="/path/to/vendor/bin"
```

### Frameworks support
Most of the time the analysis of progpilot can be extended simply with adding the corresponding [sources, sinks, validators and sanitizers](./SPECIFY_ANALYSIS.md) : look at how it was done for [current frameworks](https://github.com/designsecurity/progpilot/tree/master/package/src/uptodate_data/php/frameworks).

Expand Down
3 changes: 2 additions & 1 deletion docs/DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ 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.
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

## License

Expand Down

0 comments on commit 3701cb2

Please # to comment.