@@ -16,17 +16,6 @@ Install dependencies
1616composer install
1717```
1818
19- Composer scripts
20- ----------------
21-
22- Convenient scripts are defined in composer.json:
23-
24- - composer test — run test suite (Pest)
25- - composer type — enforce 100% type coverage via Pest plugin
26- - composer coverage — run tests with a coverage threshold
27- - composer sca — static analysis via Psalm
28- - composer cs — fix coding style with PHP-CS-Fixer
29-
3019After checkout: prepare the project
3120-----------------------------------
3221
@@ -61,44 +50,10 @@ This script will run, in order:
6150- test suite (Pest)
6251- type coverage check (100% via Pest plugin)
6352- code coverage check (100% minimum)
64- - mutation tests (threshold as configured )
53+ - mutation tests (100% minimum )
6554
6655If this command succeeds locally, your PR should pass CI checks.
6756
68-
69-
70- Project layout
71- --------------
72-
73- - src/ — library source code
74- - tests/ — test suite (Pest + PHPUnit)
75- - docs/ — documentation
76-
77- Running specific tests
78- ----------------------
79-
80- ```
81- ./vendor/bin/pest --filter PositiveInt
82- ```
83-
84- Static analysis
85- ---------------
86-
87- Psalm is configured via psalm.xml. Run:
88-
89- ```
90- composer sca
91- ```
92-
93- Code style
94- ----------
95-
96- PHP-CS-Fixer is configured via .php-cs-fixer.dist.php. To fix styles:
97-
98- ```
99- composer cs
100- ```
101-
10257Optional: Docker
10358----------------
10459
@@ -107,7 +62,7 @@ The repo contains a docker-compose.yml and a docker/php setup you can adapt. Typ
10762```
10863docker compose up -d
10964docker compose exec php composer install
110- docker compose exec php composer test
65+ docker compose exec php composer oncommit
11166```
11267
11368Contributing
0 commit comments