Skip to content

Commit 7937d5e

Browse files
committed
Updated readme
1 parent 0e34580 commit 7937d5e

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

readme.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,19 +99,24 @@ public function rules()
9999

100100
I am open for suggestions and contributions. Just create an issue or a pull request.
101101

102-
### Testing
102+
### Local docker environment
103+
104+
The `docker` folder contains a local docker enironment for development.
105+
The docker workspace has composer and xdebug installed.
103106

104107
```bash
105-
composer test
106-
composer test-coverage
108+
docker-compose run workspace bash
107109
```
108110

111+
### Testing
112+
113+
The `composer test` command runs all tests with [phpunit](https://phpunit.de/).
114+
The `composer test-coverage` command runs all tests with phpunit and creates a coverage report into the `coverage` folder.
115+
109116
### Codeformatting/Linting
110117

111-
```bash
112-
composer fix
113-
composer lint
114-
```
118+
The `composer fix` command formats the code with [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
119+
The `composer lint` command checks the code with [phpcs](https://github.com/squizlabs/PHP_CodeSniffer).
115120

116121
## Credits
117122

0 commit comments

Comments
 (0)