Skip to content

Commit 0e36a5a

Browse files
authored
Update README and .gitignore (#38)
1 parent 3516007 commit 0e36a5a

2 files changed

Lines changed: 27 additions & 2 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ phpunit.result.cache
3535

3636
# local phpunit config
3737
/phpunit.xml
38+
# phpunit cache
39+
.phpunit.result.cache
3840

3941
# NPM packages
4042
/node_modules

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ This library provides [PSR-3] compatible logging library.
1010
It is used in [Yii Framework] but is supposed to be usable separately.
1111

1212
[PSR-3]: https://www.php-fig.org/psr/psr-3/
13-
[Yii Framework]: https://github.com/yiisoft/core
13+
[Yii Framework]: http://www.yiiframework.com/
1414

1515
[![Latest Stable Version](https://poser.pugx.org/yiisoft/log/v/stable.png)](https://packagist.org/packages/yiisoft/log)
1616
[![Total Downloads](https://poser.pugx.org/yiisoft/log/downloads.png)](https://github.com/yiisoft/log/actions?query=workflow%3Abuild)
1717
[![Build status](https://github.com/yiisoft/log/workflows/build/badge.svg)](https://github.com/yiisoft/log/actions?query=workflow%3Abuild)
1818
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yiisoft/log/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/log/?branch=master)
1919
[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/log/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/log/?branch=master)
2020
[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Flog%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/log/master)
21-
[![static analysis with phan](https://github.com/yiisoft/log/workflows/static%20analysis%20with%20phan/badge.svg)](https://github.com/yiisoft/log/actions?query=workflow%3A%22static+analysis+with+phan%22)
21+
[![static analysis](https://github.com/yiisoft/log/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/log/actions?query=workflow%3A%22static+analysis%22)
2222

2323
## Logging targets
2424

@@ -28,3 +28,26 @@ Logging targets are implemented as separate packages:
2828
- [Email](https://github.com/yiisoft/log-target-email)
2929
- [File](https://github.com/yiisoft/log-target-file)
3030
- [Syslog](https://github.com/yiisoft/log-target-syslog)
31+
32+
## Unit testing
33+
34+
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
35+
36+
```php
37+
./vendor/bin/phpunit
38+
```
39+
40+
## Mutation testing
41+
42+
The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
43+
44+
```php
45+
./vendor/bin/infection
46+
```
47+
48+
## Static analysis
49+
50+
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
51+
52+
```php
53+
./vendor/bin/psalm

0 commit comments

Comments
 (0)