docs(README): improved sections with tips and notes

Author: Alcides Ramos

README.md

@@ -14,34 +14,21 @@ This repository contains an application skeleton following best practices.
 
 ### Highlights
 
-- Unified environment to build CLI, web applications and/or microservices based on **PHP8**.
-- Includes **PCOV**, **PHPCS/PHPCBF**, **PHPUnit**, **UOPZ**, **PHPStan** and a **linter** by default.
+- Minimalist project 
+- Includes frequently used tools such as a **Linter**, **PHPStan**, **PHPUnit**, **ClockMock**, **CodeSniffer** and **VarDumper**.
 
 
 ## Requirements
 
 To use this repository you need:
 
-### Sofware
+### Software
 
 - [Git](https://git-scm.com/) - The free and open source distributed version control system.
 
-### Extensions
-
-- [UOPZ](https://www.php.net/manual/en/book.uopz.php) - In order to allow mocking date/time functions
-- [PCOV](https://github.com/krakjoe/pcov) - In order to generate the PHP code coverage report
-
-
 ## Built with
 
-| Type              | Component                                                                   | Description                                                              |
-| ----------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
-| Service           | [PHP-FPM](https://www.php.net/manual/en/install.fpm.php)                    | PHP with FastCGI Process Manager                                         |
-| Miscelaneous      | [Make](https://www.gnu.org/software/make/)                                  | Allows to execute commands defined on a _Makefile_                       |
-| Quality Assurance | [PHP-Parallel-Lint](https://github.com/php-parallel-lint/PHP-Parallel-Lint) | Allows to check the syntax of PHP files in parallel                      |
-| Quality Assurance | [PHPCS/PHPCBF](https://github.com/PHPCSStandards/PHP_CodeSniffer/)          | Allows to check and fix coding style issues                              |
-| Quality Assurance | [PHPStan](https://phpstan.org/)                                             | Allows to perform static analysis of your application looking for issues |
-| Quality Assurance | [PHPUnit](https://phpunit.de/)                                              | The PHP Testing Framework                                                |
+This project was built with [Dockerized PHP](https://github.com/fonil/dockerized-php), a lightweight dockerized environment to build PHP applications. 
 
 
 ## Getting Started
@@ -76,23 +63,23 @@ $ git clone git@github.com:fonil/php-skeleton.git .
 └── README.md           # This document
 ```
 
-#### Custom commands
+#### Composer commands
 
 Custom commands are added to `composer.json` under the `scripts` section.
 
 ##### Available commands
 
-| Command          | Description                                                              |
-|------------------|--------------------------------------------------------------------------|
-| `clear-coverage` | Removes any previous HTML code coverage report                           |
-| `tests`          | Runs PHPUnit with the specs defined at `phpunit.xml` configuration file  |
-| `coverage`       | Generates the HTML code coverage report                                  |
-| `phpcs`          | Runs the PHP Check Style command following the PSR-12                    |
-| `phpcbf`         | Runs the PHP Code Beautifier and Fixer command following the PSR-12      |
-| `linter`         | Runs the linter in parallel mode                                         |
-| `phpstan`        | Runs PHPStan with the specs defined at `phpstan.neon` configuration file |
+| Command    | Description                                                  |
+| ---------- | ------------------------------------------------------------ |
+| `linter`   | Runs the linter in parallel mode                             |
+| `phpcs`    | Runs **PHP Check Style** command following the PSR-12        |
+| `phpcbf`   | Runs **PHP Code Beautifier** and **Fixer** command following the PSR-12 |
+| `phpstan`  | Runs **PHPStan** with the specs defined at `phpstan.neon` configuration file |
+| `phpunit`  | Runs **PHPUnit** with the specs defined at `phpunit.xml` configuration file |
+| `tests`    | Runs **PHPUnit** without code coverage support               |
+| `coverage` | Runs **PHPUnit** with **PCOV** code coverage support         |
 
-##### Makefile
+#### Makefile
 
 Additionally a *Makefile* is provided with frequently used commands:
 
@@ -117,22 +104,49 @@ Additionally a *Makefile* is provided with frequently used commands:
 · phpstan                        QA: <composer phpstan>
 · tests                          QA: <composer tests>
 · coverage                       QA: <composer coverage>
-· clean-cache                    QA: <composer clean-cache>
 ```
 
 
+> [!NOTE]
+>
 > This file is really useful when you create a container with a project based on this repository and you want to run those commands from outside the container, directly from your *host*. To do so just copy and paste the included steps on your main *Makefile* and adjust the constants accordingly.
 
+##### Installing Dependencies
+
+```bash
+$ make composer-install
+```
+
+##### Running the Test Cases
+
+###### Default command
+
+```bash
+$ make tests
+```
+
+###### Run only Unit  testsuite
+
+```bash
+$ make tests testsuite=Unit
+```
+
+###### Filter a specific test
+
+```bash
+$ make tests filter="checkInvokeMethod tests/Unit/Providers/FooTest.php"
+```
 
 #### Volumes
 
 ##### Coverage report in HTML
 
 Coverage report in HTML is generated on a root folder `/coverage`
 
-
+> [!TIP]
+>
 > If you want the report is generated on a different path, just update accordingly the `composer.json` file under the section `scripts`  
- 
+
 
 ## Security Vulnerabilities
 

phpunit.xml

@@ -1,21 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          cacheDirectory="/tmp/.phpunit.cache"
          executionOrder="depends,defects"
          requireCoverageMetadata="true"
          beStrictAboutCoverageMetadata="true"
          beStrictAboutOutputDuringTests="true"
          failOnRisky="true"
-         failOnWarning="true">
+         failOnWarning="true"
+>
     <testsuites>
         <testsuite name="Unit">
             <directory suffix=".php">tests/Unit</directory>
         </testsuite>
     </testsuites>
 
-    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+    <source restrictNotices="true" restrictWarnings="true" ignoreIndirectDeprecations="true">
         <include>
             <directory>app</directory>
         </include>
@@ -24,6 +25,7 @@
     <coverage includeUncoveredFiles="true"
               pathCoverage="false"
               ignoreDeprecatedCodeUnits="true"
-              disableCodeCoverageIgnore="true">
+              disableCodeCoverageIgnore="true"
+    >
     </coverage>
 </phpunit>