From 928dae70dfa9bff571570c0c4678983e5a3e0473 Mon Sep 17 00:00:00 2001 From: Dragan Gjorgjiev Date: Wed, 29 May 2024 13:47:28 +0200 Subject: [PATCH] PJAS-466 Update README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 3f6714d..67ad183 100644 --- a/README.md +++ b/README.md @@ -102,3 +102,31 @@ StartLimitBurst=10 WantedBy=multi-user.target ``` +### Code Quality + +Make sure the latest quality standards are met by executing the `phpcs` and `phpstan` scripts. There are three commands available which are defined in the root `composer.json` as custom scripts. + +Execute `phpcs` and `phpcbf` for linting and automatic fixing respectively: + +``` +composer run-script ci-phpcs +composer run-script ci-phpcs-fix +``` + +Execute `phpstan` to analyse the code to detect code issues. + +``` +composer run-script ci-phpstan +``` + +### Tests + +There are tests as part of this package in order to verify that everything works as expected. + +Execute the following command to run the tests: + +``` +composer run-script ci-phpunit +``` + +**Note: You need to configure your database connection first in `phpunit.xml` before running the tests. If `phpunit.xml` does not exist, copy the `phpunit.xml.dist` file.** \ No newline at end of file