Contributing Guidelines ======================= Table of Contents ----------------- - [Testing](#testing) - [Coding Style](#coding-style) - [PHPDoc](#phpdoc) - [Commit Message Guidelines](#commit-message-guidelines) - [Message Header](#message-header) - [Subject](#subject) - [Type](#type) - [Scope](#scope) - [Revert](#revert) - [Message Body](#message-body) - [Message Footer](#message-footer) - [Referencing Issues](#referencing-issues) - [Example Commit Messages](#example-commit-messages) - [Development Tasks CLI Commands](#development-tasks-cli-commands) - [Version Bump and Changelog](#version-bump-and-changelog) - [Git Hooks](#git-hooks) - [Installing Hooks](#installing-hooks) Testing ------- This project uses [PHPUnit](https://phpunit.de) for unit testing. The tests are usually in a Behavior-Driven Development (BDD) style. To run all tests, use the following command. ```shell "vendor/bin/phpunit" ``` Coding Style ------------ This project follows the [PSR-2 Coding Style Guide](https://www.php-fig.org/psr/psr-2/) for PHP code. [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) is used to make sure the PHP code adheres to PSR-2. Use the `php artisan lint` command to find and report coding style errors and warnings in PHP files. ### PHPDoc This project uses [PHPDoc](https://docs.phpdoc.org/references/phpdoc/index.html). Below is an example of a valid documentation block. Note that the `@param` attribute is followed by two spaces, the argument type, two more spaces, and finally the variable name: ```php /** * Register a binding with the container. * * @param string|array $abstract * @param \Closure|string|null $concrete * @param bool $shared * @return void */ public function bind($abstract, $concrete = null, $shared = false) { // } ``` Commit Message Guidelines ------------------------- The commit message guidelines are based on [Karma's commit message guidelines](http://karma-runner.github.io/1.0/dev/git-commit-msg.html) and [AngularJS commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md). Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: ```text ():