From 6da74fbf6d2e89bee2ed6bdd16fa9d5bada1ff8d Mon Sep 17 00:00:00 2001 From: lukinovec Date: Mon, 20 Feb 2023 10:25:51 +0100 Subject: [PATCH] Fix CONTRIBUTING.md --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2e76c8c..0095be7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,4 +24,16 @@ To fix this, simply delete the database memory by shutting down containers and s Run `composer docker-m1` to symlink `docker-compose-m1.override.yml` to `docker-compose.override.yml`. This will reconfigure a few services in the docker compose config to be compatible with M1. -to `docker-compose.override.yml` to make `docker-compose up -d` work on M1. +### Coverage reports + +To run tests and generate coverage reports, use `composer test-full`. + +To view the coverage reports in your browser, use `composer coverage` (works on macOS; on other operating systems you can manually open `coverage/phpunit/html/index.html` in your browser). + +### Rebuilding containers + +If you need to rebuild the container for any reason (e.g. a change in `Dockerfile`), you can use `composer docker-rebuild`. + +## PHPStan + +Use `composer phpstan` to run our phpstan suite.