README

Coding standard

Please read the Legal Things PHP coding standard.

Installation

All PHP projects of Legal Things should include this package. It can be installed through composer.

composer require --dev legalthings/php-code-quality

Toolchain

Codeception

Codeception is BDD-style PHP testing build on PHPUnit. It supports Unit testing, API testing and Acceptance testing.

bin/codecept

vfsStream

vfsStream is a stream wrapper for a virtual file system that may be helpful in unit tests to mock the real file system.

PHP_CodeSniffer

phpcs tokenises PHP files and detects violations of a defined set of coding standards. It is an essential development tool that ensures your code remains clean and consistent. This package comes with a custom ruleset which embodies the Legal Things PHP coding standard.

bin/phpcs . --standard=vendor/legalthings/php-code-quality --ignore=/bin/,/vendor/,/tests/

Versions

Always use sementic versioning. With projects, the continues integration will automatically update patch version. When introducing a new feature or deprecating something you should update the minor version in composer.json.

Do not introduce large changes or new features, while breaking backwards compatibility. For a new major version, only cleanup tasks, specifically removing deprecated code, should be done. Manually update the major version in composer.json.