Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 1.37 KB
Raw

Contributing

In order to run tests locally please make sure you have docker up and running. You also need PHP 8.1 and composer to be available from your CLI. Even that we are supporting 3 PHP versions at time, we are using the lowest supported one for development, currently it's PHP 8.1.

For the code coverage, please install pcov.

Prepare Project:

cp compose.yml.dist compose.yml
composer install 
docker compose up -d

Run Test Suite

composer test

Run Static Analyze

composer static:analyze

Fixing Coding Standards

Before committing your code, please make sure that your code is following our coding standards.

composer cs:php:fix

Test everything

This command will execute exactly the same tests as we run at GitHub Actions before PR can get merged. If it passes locally, you are good to open pull request.

composer build

Building PHAR

composer build:phar
./build/flow.phar --version

Building Docker Image

In order to build docker image and load it to local registry please use:

docker buildx build -t flow-php/flow:latest . --progress=plain  --load

Usage:

docker run -v $(pwd):/flow-workspace -it flow-php/flow:latest --version