## Workflow

* Fork the project and clone it locally
* Create a new branch for every new feature or a bug fix
* Do the necessary code changes
* Cover the new or fixed code with tests
* Write a comprehensive commit message in a format `Add the xxx feature` or `Fix the xxx bug`
* Push to the forked repository
* Create a Pull Request to the master branch of the original repository
* Make a new commit with a fix if one or more checks are failing (code analysis, tests, etc.)

## Pull Request Requirements

* Follow [PSR-2 coding style standard](https://www.php-fig.org/psr/psr-2/)
* Write tests
* Document every new feature or an interface change in the README file
* Make one Pull Request per feature / bug fix

## Running the Test Suite

To run tests locally you need PHP (7.2 or higher) and [Composer](https://getcomposer.org/download/).

Install the project dependencies:
```
composer install
```

Run the test suite:
```
make test
```

## Code Analysis

To ensure, that your code follows PSR-2 standards you can run:
```
make style-check 
```

It is also recommended to perform static code analysis before opening a PR:
```
make static-analysis 
```