Merge pull request magento#390 from magento/coding-standards_jf

jfrontain · web-flow · commit 22bf2695ecfd · 2016-10-26T07:53:27.000-05:00
MAGETWO-57282 Coding standards jf
diff --git a/guides/v2.0/coding-standards/bk-coding-standards.md b/guides/v2.0/coding-standards/bk-coding-standards.md
@@ -21,6 +21,7 @@ To code extensions, follow the Magento standards for code:
 
 - [Code demarcation standard]({{page.baseurl}}coding-standards/code-standard-demarcation.html)
 - [PHP coding standard]({{page.baseurl}}coding-standards/code-standard-php.html)
+- [PHP code sniffers]({{page.baseurl}}coding-standards/code-standard-sniffers.html)
 - [JavaScript coding standard]({{page.baseurl}}coding-standards/code-standard-javascript.html)
 - [jQuery widget coding standard]({{page.baseurl}}coding-standards/code-standard-jquery-widgets.html)
 - [DocBlock standard]({{page.baseurl}}coding-standards/docblock-standard-general.html)
diff --git a/guides/v2.0/coding-standards/code-standard-html.md b/guides/v2.0/coding-standards/code-standard-html.md
@@ -4,7 +4,7 @@ group: coding-standards
 subgroup: Coding standards
 title: HTML style guide
 menu_title: HTML style guide
-menu_order: 8
+menu_order: 9
 version: 2.0
 github_link: coding-standards/code-standard-html.md
 ---
diff --git a/guides/v2.0/coding-standards/code-standard-javascript.md b/guides/v2.0/coding-standards/code-standard-javascript.md
@@ -4,7 +4,7 @@ group: coding-standards
 subgroup: Coding standards
 title: JavaScript coding standard
 menu_title: JavaScript coding standard
-menu_order: 4
+menu_order: 5
 version: 2.0
 github_link: coding-standards/code-standard-javascript.md
 redirect_from: /guides/v1.0/coding-standards/code-standard-javascript.html
diff --git a/guides/v2.0/coding-standards/code-standard-jquery-widgets.md b/guides/v2.0/coding-standards/code-standard-jquery-widgets.md
@@ -4,7 +4,7 @@ group: coding-standards
 subgroup: Coding standards
 title: jQuery widget coding standard
 menu_title: jQuery widget coding standard
-menu_order: 6
+menu_order: 7
 version: 2.0
 github_link: coding-standards/code-standard-jquery-widgets.md
 redirect_from: /guides/v1.0/coding-standards/code-standard-jquery-widgets.html
diff --git a/guides/v2.0/coding-standards/code-standard-less.md b/guides/v2.0/coding-standards/code-standard-less.md
@@ -4,7 +4,7 @@ group: coding-standards
 subgroup: Coding standards
 title: LESS coding standard
 menu_title: LESS coding standard
-menu_order: 7
+menu_order: 8
 version: 2.0
 github_link: coding-standards/code-standard-less.md
 ---
diff --git a/guides/v2.0/coding-standards/code-standard-sniffers.md b/guides/v2.0/coding-standards/code-standard-sniffers.md
@@ -0,0 +1,30 @@
+---
+layout: default
+group: coding-standards
+subgroup: Coding standards
+title: Code sniffers
+menu_title: PHP code sniffers
+menu_order: 3
+version: 2.0
+github_link: coding-standards/code-standard-sniffers.md
+---
+
+## PHP code sniffers
+
+We recommend the consistent use of a <i>code sniffer</i> to enhance the readability of your code and help ensure that it meets Magento code standards.  A code sniffer is a tool that automates the process of identifying code irregularities. Although a sniffer will identify many more inconsistencies and errors than a manual edit, we recommend that you evaluate and make any fixes that your sniffer program identifies.  
+
+Magento recommends the use of <a href="http://pear.php.net/manual/en/package.php.php-codesniffer.faq.php" target="_blank">PHP_CodeSniffer</a>, the most popular code sniffer in use throughout the PHP development community.  PHP_CodeSniffer implements the full PSR4 standard. You can extend PHP_CodeSniffer to include your own rules, too, <a href="https://github.com/magento/magento2/blob/develop/dev/tests/static/framework/Magento/ruleset.xml" target="_blank">as we have</a>. The <a href="https://github.com/magento-ecg/coding-standard" target="_blank">ECG Magento PHP Code Sniffer Coding Standard</a> provides specifications that you can use to configure your code sniffer of choice to bring your <i>PHP coding style closer to Magento PHP standards</i>.
+
+
+
+### Code standards 
+
+Magento supports the full <a href="http://stackoverflow.com/questions/24868586/what-is-the-difference-between-psr-0-and-psr-4983" target="_blank">PSR4</a> standard plus some Magento-specific coding practices. 
+
+
+The <a href="http://devdocs.magento.com/guides/v2.0/coding-standards/bk-coding-standards.html" target="_blank">Coding standards overview</a> introduces Magento-specific practices for PHP, JavaScript, and JQuery. 
+
+
+
+
+
diff --git a/guides/v2.0/coding-standards/docblock-standard-general.md b/guides/v2.0/coding-standards/docblock-standard-general.md
@@ -4,7 +4,7 @@ group: coding-standards
 subgroup: Coding standards
 title: DocBlock standard
 menu_title: DocBlock standard
-menu_order: 3
+menu_order: 4
 version: 2.0
 github_link: coding-standards/docblock-standard-general.md
 redirect_from: /guides/v1.0/coding-standards/docblock-standard-general.html
diff --git a/guides/v2.0/coding-standards/docblock-standard-javascript.md b/guides/v2.0/coding-standards/docblock-standard-javascript.md
@@ -4,7 +4,7 @@ group: coding-standards
 subgroup: Coding standards
 title: JavaScript DocBlock standard
 menu_title: JavaScript DocBlock standard
-menu_order: 5
+menu_order: 6
 version: 2.0
 github_link: coding-standards/docblock-standard-javascript.md
 redirect_from: /guides/v1.0/coding-standards/docblock-standard-javascript.html
