You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/internals.md
+10-13
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Testing
1
+
# Internals
2
2
3
3
## Github actions
4
4
@@ -10,7 +10,7 @@ All our packages have github actions by default, so you can test your [contribut
10
10
11
11
For greater ease it is recommended to use docker containers, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that is in the docs folder.
12
12
13
-
1.[Oracle 21](/docker-compose.yml)
13
+
1.[Oracle 21](../docker-compose.yml)
14
14
15
15
For running the docker containers you can use the following command:
16
16
@@ -20,9 +20,7 @@ docker compose up -d
20
20
21
21
## Unit testing
22
22
23
-
The package is tested with [PHPUnit](https://phpunit.de/).
24
-
25
-
The following steps are required to run the tests:
23
+
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
26
24
27
25
1. Run the docker container for the dbms.
28
26
2. Install the dependencies of the project with composer.
@@ -32,7 +30,7 @@ The following steps are required to run the tests:
32
30
vendor/bin/phpunit
33
31
```
34
32
35
-
###Mutation testing
33
+
## Mutation testing
36
34
37
35
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
38
36
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
@@ -49,20 +47,19 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
49
47
./vendor/bin/psalm
50
48
```
51
49
52
-
## Rector
50
+
## Code style
53
51
54
-
Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
55
-
use either newest or any specific version of PHP:
52
+
Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
53
+
use either newest or any specific version of PHP:
56
54
57
55
```shell
58
56
./vendor/bin/rector
59
57
```
60
58
61
-
## Composer require checker
62
-
63
-
This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.
59
+
## Dependencies
64
60
65
-
To run the checker, execute the following command:
61
+
This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if
62
+
all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command:
0 commit comments