1- # CONTRIBUTING
1+ # Contributing
22
3- We are using [ GitHub Actions] ( https://github.com/features/actions ) as a continuous integration system.
3+ We use [ GitHub Actions] ( https://github.com/features/actions ) as a continuous integration system.
44
55For details, take a look at the following workflow configuration files:
66
77- [ ` workflows/integrate.yaml ` ] ( workflows/integrate.yaml )
8+ - [ ` workflows/merge.yaml ` ] ( workflows/merge.yaml )
89- [ ` workflows/release.yaml ` ] ( workflows/release.yaml )
910- [ ` workflows/triage.yaml ` ] ( workflows/triage.yaml )
1011
12+ ## Backward-Compatibility Analysis
13+
14+ We use [ ` roave/backward-compatibility-check ` ] ( https://github.com/Roave/BackwardCompatibilityCheck ) to prevent breaking backwards-compatibility.
15+
16+ Run
17+
18+ ``` sh
19+ make backward-compatibility-analysis
20+ ```
21+
22+ to run a backward-compatibility analysis.
23+
1124## Coding Standards
1225
13- We are using [ ` ergebnis/composer-normalize ` ] ( https://github.com/ergebnis/composer-normalize ) to normalize ` composer.json ` .
26+ We use [ ` ergebnis/composer-normalize ` ] ( https://github.com/ergebnis/composer-normalize ) to normalize ` composer.json ` .
1427
15- We are using [ ` yamllint ` ] ( https://github.com/adrienverge/yamllint ) to enforce coding standards in YAML files.
28+ We use [ ` yamllint ` ] ( https://github.com/adrienverge/yamllint ) to enforce coding standards in YAML files.
1629
1730If you do not have ` yamllint ` installed yet, run
1831
1932``` sh
20- $ brew install yamllint
33+ brew install yamllint
2134```
2235
2336to install ` yamllint ` .
2437
25- We are using [ ` friendsofphp/php-cs-fixer ` ] ( https://github.com/FriendsOfPHP/PHP-CS-Fixer ) to enforce coding standards in PHP files.
38+ We use [ ` friendsofphp/php-cs-fixer ` ] ( https://github.com/FriendsOfPHP/PHP-CS-Fixer ) to enforce coding standards in PHP files.
2639
2740Run
2841
2942``` sh
30- $ make coding-standards
43+ make coding-standards
3144```
3245
3346to automatically fix coding standard violations.
3447
3548## Static Code Analysis
3649
37- We are using [ ` vimeo/psalm ` ] ( https://github.com/vimeo/psalm ) to statically analyze the code.
50+ We use [ ` vimeo/psalm ` ] ( https://github.com/vimeo/psalm ) to statically analyze the code.
3851
3952Run
4053
4154``` sh
42- $ make static-code-analysis
55+ make static-code-analysis
4356```
4457
4558to run a static code analysis.
4659
4760## Tests
4861
49- We are using [ ` phpunit/phpunit ` ] ( https://github.com/sebastianbergmann/phpunit ) to drive the development.
62+ We use [ ` phpunit/phpunit ` ] ( https://github.com/sebastianbergmann/phpunit ) to drive the development.
5063
5164Run
5265
5366``` sh
54- $ make tests
67+ make tests
5568```
5669
5770to run all the tests.
@@ -61,7 +74,7 @@ to run all the tests.
6174Run
6275
6376``` sh
64- $ make
77+ make
6578```
6679
6780to enforce coding standards, run a static code analysis, and run tests!
@@ -71,7 +84,7 @@ to enforce coding standards, run a static code analysis, and run tests!
7184:bulb : Run
7285
7386``` sh
74- $ make help
87+ make help
7588```
7689
7790to display a list of available targets with corresponding descriptions.
0 commit comments