Differences

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

--- standards [2015/11/11 03:43] – mnewnham
+++ project:standards [2016/01/31 19:36] (current) – mnewnham
@@ Line 1: / Line 1: @@
+====== Coding Standards ======
+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 =====
+Release versions numbering now follows the standards defined at [[http://semver.org|Semantic Versioning]]
+===== Code Documentation =====
+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 accepted, ADOdb documentation standards will likely encompass those as well.
 ===== Coding Standards =====
-We have adopted the following coding standards for the ADOdb project.
+ADOdb Version 6 will be coded to the PHP Framework Interop Group [[http://www.php-fig.org/psr/psr-2/|PSR-2]] standards.
-==== Version Numbering ====
-Release versions numbering follows the standards defined at [[http://semver.org|Semantic Versioning]]
+Code style validation can be done using [[http://pear.php.net/package/PHP_CodeSniffer/redirected|PHP_CodeSniffer]]
-==== Code Documentation ====
+===== Testing =====
-Code is documented to guidelines defined at [[http://phpdoc.org|PHPDocumetor]]. In order to add missing documentation, a templated docblock has been added to each file, class function and method. Each docblock contains a number of custom adodb tags. These tags are documented below. When modifying existing code, there is no need to fix all the documentation inside the file, but please update the documentation for the modified function.
+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.
-===== Coding Standards =====
-Please code to PEAR standards. Validate using PHP_CodeSniffer
-===== Custom ADOdb tags =====
-==== File Tags ====
-=== adodb-filecheck-status ====
-=== adodb-codesniffer-status===
-=== adodb-documentor-status ===
-==== Class Tags ====
-=== adodb-class-status ===
-If you can identify whether the class is final/abstract etc, change this tag to reflect the value. Please do not change the class itself. These changes will be made in a later release.
-==== Function Tags ====
-=== adodb-visibility ===
-=== adodb-function-status ===
-=== adodb-api ===
-==== Method Tags ====
+===== Apologies =====
-=== adodb-visibility ===
+If you have your own tools built around the original documentation standards, we apologize for the inconvenience.
-=== adodb-function-status ===
-=== adodb-api ==
-If the method conforms to the requirements defined by the phpdocumentor [[http://phpdoc.org/docs/latest/references/phpdoc/tags/api.html|api]] tag, then:
-  - Remove the adodb-api tag
-  - add the @api tag
-If the method does not conform, simply remove the adodb-api tag.
+{{tag>[semantic phpdocumentor codesniffer]}}