About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:coding_standards

This is an old revision of the document!


Coding Standards

PHP

VuFind uses the PEAR Coding Standards for its PHP code. Several additional recommendations are enforced using the php-cs-fixer tool. For help with standards compliance, see the recommended tools page.

Javascript

ESLint style enforcement in progress. Will use ESLint recommended with a few extra rules. Join in the conversation on this pull request.

Templates

Style guide forth-coming.

CSS

No strict coding practices enforced, although the Code Guide by Bootstrap creator Mark Otto is a recommended read.

Editor Config

# editorconfig.org

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.php]
indent_size = 4
development/coding_standards.1464098347.txt.gz · Last modified: 2016/05/24 13:59 by crhallberg