How to contribute

Contributions to the Composer update check plugin are very welcome.

Please follow the guide on this page if you want to contribute. Make sure that all required code quality checks are green. If you need help, feel free to file an issue and I will try to assist you wherever needed.

Preparation

# Clone repository
git clone https://github.com/eliashaeussler/composer-update-check.git
cd composer-update-check

# Install Composer dependencies
composer install

Check code quality

Code quality can be checked by running the following commands:

# Run linters
composer lint
composer lint:composer
composer lint:php

# Run static code analysis
composer sca
composer sca:php

Run tests

Unit tests can be executed using the provided Composer script test. You can pass all available arguments to PHPUnit.

# Run tests
composer test

# Run tests and generate code coverage
composer test:coverage

Run Docker tests

All test applications can also be executed with the generated Docker images. All available parameters for the update-check command can be passed.

# Run tests for the Docker image using Composer 2.x
./bin/run-docker-tests.sh --composer-version 2

# Run tests for the Docker image using Composer 2.x and PHP 8.0
./bin/run-docker-tests.sh --composer-version 2 --php-version "8.0"

# Run tests with optional parameters
./bin/run-docker-tests.sh --composer-version 2 --security-scan --no-dev

Simulate application

A Composer script simulate exists which lets you run the Composer command update-check. All parameters passed to the script will be redirected to the Composer command.

# Run "composer update-check" command without parameters
composer simulate

# Pass parameters to "composer update-check" command
composer simulate -- -i "composer/*"
composer simulate -- --no-dev

Alternatively, this script can be called without Composer context:

./bin/simulate-application.sh

Build documentation

# Build documentation and watch for changes
composer docs

# Build documentation for production use
composer docs:build