About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


development:coding_standards

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
development:coding_standards [2015/12/11 18:45]
demiankatz ↷ Links adapted because of a move operation
development:coding_standards [2016/05/24 13:59] (current)
crhallberg
Line 1: Line 1:
 ====== Coding Standards ====== ====== Coding Standards ======
 +
 +===== PHP =====
  
 VuFind uses the [[http://​pear.php.net/​manual/​en/​standards.php|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 [[development:​recommended_tools#​style|recommended tools page]]. VuFind uses the [[http://​pear.php.net/​manual/​en/​standards.php|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 [[development:​recommended_tools#​style|recommended tools page]].
 +
 +===== Javascript =====
 +
 +ESLint style enforcement in progress. Will use ESLint recommended with a few extra rules. Join in the conversation on [[https://​github.com/​vufind-org/​vufind/​pull/​700|this pull request]].
 +
 +===== Templates =====
 +
 +Style guide forth-coming.
 +
 +===== CSS =====
 +
 +No strict coding practices enforced, although the [[http://​codeguide.co/​|Code Guide]] by Bootstrap creator Mark Otto is a recommended read.
 +
 +===== Editor Config =====
 +<​code>​
 +# 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
 +</​code>​
  
development/coding_standards.txt · Last modified: 2016/05/24 13:59 by crhallberg