artisansdk/contract

Contracts (interfaces) for framework extensions included in Artisan SDK.

dev-master 2021-10-23 01:32 UTC

This package is auto-updated.

Last update: 2022-06-23 02:51:56 UTC


README

Contracts (interfaces) for framework extensions included in Artisan SDK.

Table of Contents

Installation

The package installs into a PHP application like any other PHP package:

composer require artisansdk/contract

Usage Guide

The common use cases for this package should be documented including any troubleshooting.

Running the Tests

The package is unit tested with 100% line coverage and path coverage. You can run the tests by simply cloning the source, installing the dependencies, and then running ./vendor/bin/phpunit. Additionally included in the developer dependencies are some Composer scripts which can assist with Code Styling and coverage reporting:

composer test
composer fix
composer report

See the composer.json for more details on their execution and reporting output.

Licensing

Copyright (c) 2018-2021 Artisans Collaborative

This package is released under the MIT license. Please see the LICENSE file distributed with every copy of the code for commercial licensing terms.