File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -31,20 +31,32 @@ install and usage example.
3131Bugs and feature request are tracked on [ GitHub] ( https://github.com/bigbluebutton/bigbluebutton-api-php/issues )
3232
3333## Contributing guidelines
34- ### Code style
34+ ### Code Quality ( style)
3535
3636Make sure the code style configuration is applied by running PHPCS-Fixer.
3737
38+ ``` bash
39+ # using an alias
40+ $ composer cs-fix
3841```
39- composer cs-fix
42+
43+ ### Code Quality (static code analysis)
44+ PHPStan shall be used for static code analysis by running the command below:
45+
46+ ``` bash
47+ # using an alias
48+ $ composer code-check
49+
50+ # or the same w/o alias
51+ $ ./vendor/bin/phpstan analyse
4052```
4153
4254### Running tests
4355
4456For every implemented feature add unit tests and check all is green by running the command below.
4557
4658``` bash
47- composer test
59+ $ composer test
4860```
4961
5062To run a single test
Original file line number Diff line number Diff line change 4242 "phpstan/phpstan" : " ^1.10"
4343 },
4444 "scripts" : {
45+ "code-check" : " ./vendor/bin/phpstan analyse" ,
4546 "test" : " ./vendor/bin/phpunit" ,
4647 "test-cov" : " XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html coverage" ,
4748 "cs-fix" : " PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --allow-risky yes" ,
You can’t perform that action at this time.
0 commit comments