Fix minor corrections. (#57)

Author: terabytesoftw

.github/workflows/bc.yml_

@@ -0,0 +1,15 @@
+on:
+ - 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

.github/workflows/build.yml

@@ -7,8 +7,8 @@ name: build
 jobs:
  tests:
  name: PHP ${{ matrix.php }}-${{ matrix.os }}
+
  env:
- extensions: mbstring
  key: cache-v1
 
  runs-on: ${{ matrix.os }}
@@ -27,26 +27,10 @@ jobs:
  - name: Checkout
  uses: actions/checkout@v2.3.4
 
- - name: Setup cache environment
- id: cache-env
- uses: shivammathur/cache-extensions@v1
- with:
- php-version: ${{ matrix.php }}
- extensions: ${{ env.extensions }}
- key: ${{ env.key }}
-
- - name: Cache extensions
- uses: actions/cache@v1
- with:
- path: ${{ steps.cache-env.outputs.dir }}
- key: ${{ steps.cache-env.outputs.key }}
- restore-keys: ${{ steps.cache-env.outputs.key }}
-
- - name: Install PHP with extensions
+ - name: Install PHP
  uses: shivammathur/setup-php@v2
  with:
  php-version: ${{ matrix.php }}
- extensions: ${{ env.extensions }}
  ini-values: date.timezone='UTC'
  coverage: pcov
  tools: composer:v2
@@ -67,6 +51,9 @@ jobs:
  restore-keys: |
  php${{ matrix.php }}-composer-
 
+ - name: Update composer
+ run: composer self-update
+
  - name: Install dependencies with composer php 7.4
  if: matrix.php == '7.4'
  run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
@@ -75,16 +62,5 @@ jobs:
  if: matrix.php == '8.0'
  run: composer update --ignore-platform-reqs --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
- - name: Run tests with phpunit and coverage on Linux php 7.4
- if: matrix.os == 'ubuntu-latest' && matrix.php == '7.4'
- run: vendor/bin/phpunit --coverage-clover=coverage.clover --colors=always
-
- - name: Run tests with phpunit without coverage
- if: matrix.os != 'ubuntu-latest' || matrix.php != '7.4'
+ - name: Run tests with phpunit
  run: vendor/bin/phpunit --colors=always
-
- - name: Upload code coverage scrutinizer on Linux php 7.4
- if: matrix.os == 'ubuntu-latest' && matrix.php == '7.4'
- run: |
- wget https://scrutinizer-ci.com/ocular.phar
- php ocular.phar code-coverage:upload --format=php-clover coverage.clover

.github/workflows/mutation.yml

@@ -43,6 +43,9 @@ jobs:
  restore-keys: |
  php${{ matrix.php }}-composer-
 
+ - name: Update composer
+ run: composer self-update
+
  - name: Install dependencies with composer
  run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 

.github/workflows/static.yml

@@ -40,6 +40,9 @@ jobs:
  restore-keys: |
  php${{ matrix.php }}-composer-
 
+ - name: Update composer
+ run: composer self-update
+
  - name: Install dependencies with composer
  run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 

README.md

@@ -176,3 +176,46 @@ if ($startsWithTest->match($fileName)) {
  echo 'It is a config!';
 }
 ```
+
+### 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. To run it:
+
+```shell
+./vendor/bin/infection
+```
+
+### Static analysis
+
+The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
+
+```shell
+./vendor/bin/psalm
+```
+
+### Support the project
+
+[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)
+
+### Follow updates
+
+[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
+[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)
+[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
+[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
+[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
+
+## License
+
+The Yii Strings is free software. It is released under the terms of the BSD License.
+Please see [`LICENSE`](./LICENSE.md) for more information.
+
+Maintained by [Yii Software](https://www.yiiframework.com/).