polderknowledge/coding-standards

The Polder Knowledge coding standards for PHP_CodeSniffer.

2.1.0 2019-10-29 15:45 UTC

Requires

• php: ^7.1
• doctrine/coding-standard: ^6.0

Requires (Dev)

• roave/security-advisories: dev-master

MIT

• code
• rules
• style
• standards
• standard
• sniffer
• coding
• cs
• sniffs
• checks
• polderknowledge
• coding-standards

README

This repository contains the PHP_CodeSniffer configuration for PHP coding standards used for projects we build. The file is an extension on the PSR-2 defaults. And can be used by any PHP project.

Install

Via Composer

$ composer require polderknowledge/coding-standards

Usage

Set the standard attribute in your build script to:

<phpcodesniffer standard="${project.basedir}/vendor/polderknowledge/coding-standards/PolderKnowledge/ruleset.xml">
    <!-- rest of your phpcodesniffer target -->
</phpcodesniffer>

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ vendor/bin/phpunit

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please report them via HackerOne instead of using the issue tracker or e-mail.

Community

We have an IRC channel where you can find us every now and then. We're on the Freenode network in the channel #polderknowledge.

Credits

• Polder Knowledge
• All Contributors

License

Please see LICENSE.md for the license of this application.