Dev.Coding Standards

Pi Development Best Practice

• Standard

  • CSS Standard
  • JavaScript Standard
  • HTML Standard

• Coding Standards

  • PHP - PSR compliant https://github.com/php-fig/fig-standards http://framework.zend.com/wiki/display/ZFDEV2/Coding+Standards
  • HTML/CSS - Google HTML/CSS Style Guide http://google-styleguide.googlecode.com/svn/trunk/htmlcssguide.xml
  • JavaScript - Google JavaScript Style Guide http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
  • All code must be strictly compliant to its corresponding standards, no warning/notice messages allowed

• Semantic Versioning Specification

  • For transparency and insight into our release cycle, and striving to maintain backward compatibility, Xoops/Pi Engine will be maintained under the Semantic Versioning guidelines as much as possible.
  • Releases will be numbered in the following format: <major>.<minor>.<patch> And constructed with the following guidelines:
    • Breaking backward compatibility bumps the major (and resets the minor and patch)
    • New additions without breaking backward compatibility bumps the minor (and resets the patch)
    • Bug fixes and misc changes bumps the patch

---

Third-party libraries utilized in this framework:

1. PHP - Zend Framework 2
2. JavaScript - jQuery
3. CSS/JS - Bootstrap/Backbone