Websocket: Contributing

October 27, 2023 · View on GitHub

Everyone is welcome to help out! But to keep this project sustainable, please ensure your contribution respects the requirements below.

PR Requirements

Requirements on pull requests;

Base your patch on corresponding version branch, and target that version branch in your pull request.

Version	Branch	PHP	Status
`2.0`	`v2.0-main`	`^8.0`	Current version
`1.7`	`v1.7-master`	`^7.4\|^8.0`	Bug fixes only
`1.6`	`v1.6-master`	`^7.4\|^8.0`	-
`1.5`	`v1.5-master`	`^7.4\|^8.0`	-
`1.4`	-	`^7.1`	-
`1.3`	-	`^5.4\|^7.0`	-
`1.2`	-	-	-
`1.1`	-	-	-
`1.0`	-	-	-

Install or update dependencies using Composer.

# Install dependencies
make install

# Update dependencies
make update

This project uses PSR-1 and PSR-12 code standards.

# Check code standard adherence
make cs-check

Unit tests with PHPUnit, coverage with Coveralls

# Run unit tests
make test

# Create coverage
make coverage