Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve readme + Update bc.yml and code of conduct (#574)
* Update Code of Conduct * update bc.yml * readme * Update README.md Co-authored-by: Alexey Rogachev <arogachev90@gmail.com> * Update README.md Co-authored-by: Alexey Rogachev <arogachev90@gmail.com> * Update README.md Co-authored-by: Alexey Rogachev <arogachev90@gmail.com> --------- Co-authored-by: Alexey Rogachev <arogachev90@gmail.com>
- Loading branch information
Showing
4 changed files
with
174 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,14 @@ | ||
on: | ||
- pull_request | ||
- push | ||
- pull_request | ||
- push | ||
|
||
name: backwards compatibility | ||
|
||
jobs: | ||
roave_bc_check: | ||
name: Roave BC Check | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@master | ||
- name: fetch tags | ||
run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* | ||
- name: Roave BC Check | ||
uses: docker://nyholm/roave-bc-check-ga | ||
roave_bc_check: | ||
uses: yiisoft/actions/.github/workflows/bc.yml@master | ||
with: | ||
os: >- | ||
['ubuntu-latest'] | ||
php: >- | ||
['8.0'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Internals | ||
|
||
## Unit testing | ||
|
||
The package is tested with [PHPUnit](https://phpunit.de/). To run tests: | ||
|
||
```shell | ||
./vendor/bin/phpunit | ||
``` | ||
|
||
## Mutation testing | ||
|
||
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with | ||
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it: | ||
|
||
```shell | ||
./vendor/bin/roave-infection-static-analysis-plugin | ||
``` | ||
|
||
## Static analysis | ||
|
||
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis: | ||
|
||
```shell | ||
./vendor/bin/psalm | ||
``` | ||
|
||
## Code style | ||
|
||
Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or | ||
use either newest or any specific version of PHP: | ||
|
||
```shell | ||
./vendor/bin/rector | ||
``` | ||
|
||
## Dependencies | ||
|
||
Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive | ||
[Composer](https://getcomposer.org/) dependencies. |