CONTRIBUTING.md

Contributing

Quick Guide

1. Fork this repository to your own GitHub account and then clone it to your local machine.
2. Install the dependencies (composer install --dev)
3. Create a new branch (git checkout -b feat/new-feature)
4. Write your feature or fix and make sure tests pass and code standards are met (see below)
5. Commit your changes (git commit -m 'feat(new-feature): some feature or fix')
6. Push to the branch (git push origin feat/new-feature)
7. Open a pull request

Working with Docker

This project provides a Docker setup that allows working on it using any of the supported PHP versions.

To use it, you first need to install:

• Docker
• Docker Compose

Make sure the versions installed support Compose file format 3.9.

You can then build the images:

docker compose up --build -d

Now you can run commands needed to work on the project. For example, say you want to install the dependencies on PHP 8.0:

docker-compose run php-80 composer install

or for enter in the container

docker-compose exec php-80 sh

Testing

To run the test use the command below:

composer test

# or if you want see the coverage

composer test-coverage-html

Coding standards fixer

composer php-cs-fixer

Commit guidelines

Please see the Conventional Commits for commit guidelines.

Contributors

Below the list of all contributors:

• @antonioturdo
• @JellyBellyDev