ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools


project:standards

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
standards [2015/07/07 04:05] mnewnhamproject:standards [2016/01/31 19:36] (current) mnewnham
Line 1: Line 1:
-===== Developer Standards ===== +====== Coding Standards ====== 
-The following coding standards have been adopted by the ADOdb project. +As the ADOdb project has moved from an owner-controlled project to a more distributed-development environment we have adopted the following coding standards for the ADOdb project, based on their existing widespread use.  
-==== Version Numbering ==== +===== Version Numbering ===== 
-Release versions numbering follows the standards defined at [[http://semver.org|Semantic Versioning]] +Release versions numbering now follows the standards defined at [[http://semver.org|Semantic Versioning]] 
-==== Code Documentation ==== +===== Code Documentation ===== 
-Code is documented to guidelings defined at [[http://phpdoc.org|PHPDocumetor]]. When modifying existing code, there is no need to fix all the documentation inside the filebut please update the documentation for the modified function. +ADOdb Version 6 Code will be documented to guidelines defined at [[http://phpdoc.org|PHPDocumentor]]. If [[http://www.php-fig.org/psr|PHP-FIG PSR-5]] is acceptedADOdb documentation standards will likely encompass those as well.
-==== Coding Standards ==== +
-Please code to PEAR standards. Validate using PHP_CodeSniffer+
  
 +===== Coding Standards =====
 +ADOdb Version 6 will be coded to the PHP Framework Interop Group [[http://www.php-fig.org/psr/psr-2/|PSR-2]] standards. 
 +
 +Code style validation can be done using [[http://pear.php.net/package/PHP_CodeSniffer/redirected|PHP_CodeSniffer]]
 +===== Testing =====
 +There are a number of tests available in the adodb/tests directory. Future releases will likely have a test suite built around [[https://phpunit.de/|PHPunit]] tests.
 +
 +
 +===== Apologies =====
 +If you have your own tools built around the original documentation standards, we apologize for the inconvenience.
 +
 +{{tag>[semantic phpdocumentor codesniffer]}}
project/standards.1436234728.txt.gz · Last modified: 2017/04/21 11:19 (external edit)