Skip to content

Commit

Permalink
Update internals.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vjik authored May 18, 2024
1 parent b03c84e commit 78647c7
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ For running the Docker containers you can use the following command:
docker compose up -d
```

## Unit testing

The package is tested with [PHPUnit](https://phpunit.de/).

### Global testing

The following steps are required to run the tests.
Expand Down Expand Up @@ -78,7 +82,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
./vendor/bin/psalm
```

## Rector
## 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:
Expand All @@ -87,11 +91,10 @@ use either newest or any specific version of PHP:
./vendor/bin/rector
```

## Composer require checker

This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.
## Dependencies

To run the checker, execute the following command:
This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if
all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command:

```shell
./vendor/bin/composer-require-checker
Expand Down

0 comments on commit 78647c7

Please sign in to comment.