README

A common coding standard for @ramsey's PHP libraries.

About

This is a custom coding standard for PHP_CodeSniffer. It borrows many sniffs from Slevomat Coding Standard and PHPCSExtra and combines them into a single unified, common standard for @ramsey's PHP libraries.

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.

Installation

Install this package as a development dependency using Composer.

composer require --dev ramsey/coding-standard

Usage

To use this coding standard, add to your phpcs.xml configuration.

Here are the contents of an example phpcs.xml.dist file that you may place in the root of your repository:

xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">

    <arg name="extensions" value="php"/>
    <arg name="colors"/>
    <arg value="sp"/>

    <file>./srcfile>
    <file>./testsfile>

    <rule ref="Ramsey"/>

ruleset>

Then, run PHP_CodeSniffer:

./vendor/bin/phpcs

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

Coordinated Disclosure

Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers. If you believe you've found a security issue in software that is maintained in this repository, please read SECURITY.md for instructions on submitting a vulnerability report.

Copyright and License

The ramsey/coding-standard library is copyright © Ben Ramsey and licensed for use under the terms of the MIT License (MIT). Please see LICENSE for more information.