pretty-helpful-php / coding-standard
Pretty Helpful PHP coding standard
v1.0.0
2019-03-04 00:51 UTC
Requires
This package is auto-updated.
Last update: 2024-06-14 03:13:47 UTC
README
Introduction
The Pretty Helpful PHP coding standard is a PSR-2-based coding standard built for use with PHP_CodeSniffer.
This coding standard was written with the following basic principles in mind:
- Be consistent.
- Keep functions simple and easy to read.
- Avoid practices that lead to unreliable code or unreliable tests.
Installation
This standard is configured for use with Composer.
To install it as a dependency, run the following command:
composer require pretty-helpful-php/coding-standard --dev
How to use
Once the standard is installed, it can be run from command line using the following command:
phpcs --standard=PrettyHelpfulPHP /path/to/somefile.php
See the PHP_CodeSniffer usage page for more information.
Contributing
Contributions are welcome. See contributing for more information.
License
This coding standard is published under the MIT license.