Skip to content

itdc/coding-standards

Folders and files

NameName
Last commit message
Last commit date

Latest commit

bdd1597 · Aug 31, 2015

History

2 Commits
Aug 31, 2015
Aug 31, 2015
Aug 31, 2015
Aug 31, 2015
Aug 31, 2015
Aug 31, 2015

Repository files navigation

ITDC Coding Standards

This repository includes the ITDC coding standard definition for PHP Codesniffer along with a few other helpful resources. The PHP_CodeSniffer standard will never be 100% accurate, but should be viewed as a strong set of guidelines while writing software for ITDC code.

See ITDC coding standards documentation at http://itdc.github.io/coding-standards/

If you want to contribute and improve this documentation find the source files at https://github.com/itdc/coding-standards/tree/gh-pages

Requirements

Installation

Installation is as easy as checking out the repository to the correct location within PHP_CodeSniffer's directory structure.

Install PHP_CodeSniffer.

composer global require "squizlabs/php_codesniffer=*"

Install the ITDC standard.

git clone https://github.com/itdc/coding-standards.git `pear config-get php_dir`/PHP/CodeSniffer/Standards/ITDC

Running

You can use the installed ITDC standard like:

phpcs --standard=ITDC code path/to/code

Alternatively if it isn't installed you can still reference it by path like:

phpcs --standard=path/to/itdc/coding-standards path/to/code

IDE autoformatters

There is further information on how to set up IDE auto formatters here:

https://github.com/itdc/coding-standards/tree/master/IDE

Credits

Created by Avtandil Kikabidze aka LONGMAN.

Releases

No releases published

Packages

No packages published