Updated corresponding pages due to with Magento Coding Standard release #4360

lenaorobei · 2019-04-26T18:26:56Z

Purpose of this PR

This PR adds information about Magento Coding Standard and fixes outdated pages in this regard.

Affected URLs

Request for Review:

@jeff-matthews
@dshevtsov
@paliarush

whatsnew
Added information about the Magento Coding Standard to the following topics:

- added info about Magento Coding Standard - fixed outdated information

magento-engcom-team · 2019-04-26T18:26:58Z

@lenaorobei thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

magento-cicd2 · 2019-04-26T18:26:58Z

All committers have signed the CLA.

devops-devdocs · 2019-04-26T18:27:05Z

An admin must run tests on this PR before it can be merged.

lenaorobei · 2019-04-26T18:55:18Z

Adding more clarity here:

Moved code-standard-sniffers.html content under code-standard-php.html page, because Code Sniffer is a tool that allows to check the code compliance with specific Coding Standard.
Replaced links to outdated MEQP Coding Standard with new one consolidated Magento Coding Standard.
Fixed Templates XSS security with relevant for 2.3 approach of testing phtml templates.

paliarush · 2019-04-30T14:48:54Z

guides/v2.1/coding-standards/code-standard-php.md

-Otherwise, you must apply these standards and requirements through rigorous code review.
+Magento Coding Standard provides the set of rules which cover following:
+* [PSR-1]{:target="_blank"} and [PSR-2]{:target="_blank"} compliance
+* the use of insecure functions


Do we really want to list all custom rules here? It may be difficult to maintain these docs up-to-date.

I don't see an issue here. It looks good to me that we explicitly declare PHP standard we are following.

jeff-matthews

Thanks for the PR @lenaorobei! Please see my minor editorial suggestions.

guides/v2.1/coding-standards/code-standard-php.md

guides/v2.1/ext-best-practices/extension-coding/security-performance-data-bp.md

guides/v2.2/extension-dev-guide/validate/test-module.md

guides/v2.1/extension-dev-guide/validate/test-module.md

guides/v2.3/extension-dev-guide/validate/test-module.md

Co-Authored-By: lenaorobei <oorobei@magento.com>

lenaorobei · 2019-05-02T14:36:14Z

@jeff-matthews thank you fo the review and suggestions.

jeff-matthews · 2019-05-02T14:42:40Z

running tests

jeff-matthews · 2019-05-02T15:34:50Z

Tests failed. Here's the log.

rake test:cicd
�[35mChecking links with htmlproofer...�[0m
Running ["LinkChecker::DoubleSlashCheck", "ImageCheck", "ScriptCheck", "LinkCheck"] on ["_site"] on *.html...

Ran on 4098 files!

- internally linking to /guides/v2.1/coding-standards/code-standard-sniffers.html, which does not exist
  *  _site/guides/v2.1/coding-standards/bk-coding-standards.html (line 208)
     <a href="/guides/v2.1/coding-standards/code-standard-sniffers.html">PHP code sniffers</a>
- internally linking to /guides/v2.2/coding-standards/code-standard-sniffers.html, which does not exist
  *  _site/guides/v2.2/coding-standards/bk-coding-standards.html (line 208)
     <a href="/guides/v2.2/coding-standards/code-standard-sniffers.html">PHP code sniffers</a>
- internally linking to /guides/v2.3/coding-standards/code-standard-sniffers.html, which does not exist
  *  _site/guides/v2.3/coding-standards/bk-coding-standards.html (line 208)
     <a href="/guides/v2.3/coding-standards/code-standard-sniffers.html">PHP code sniffers</a>
rake aborted!
HTML-Proofer found 3 failures!```

jeff-matthews · 2019-05-02T15:45:32Z

@lenaorobei, please remove the links to the deleted Code Sniffer file in the following files:

guides/v2.1/coding-standards/bk-coding-standards.md
guides/v2.2/test/testing.md
guides/v2.3/test/testing.md
_data/whats-new.yml

- removed dead link

- fixed dead links

lenaorobei · 2019-05-02T15:59:33Z

@jeff-matthews, done.

jeff-matthews · 2019-05-02T17:40:20Z

running tests

ghost · 2019-05-02T18:20:28Z

Hi @lenaorobei, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

REPO-203: [EQP][Sniffs Consolidation] Update Magento DevDocs pages

664233f

- added info about Magento Coding Standard - fixed outdated information

lenaorobei changed the title ~~REPO-203: [EQP][Sniffs Consolidation] Update Magento DevDocs pages~~ Updated corresponding pages due to with Magento Coding Standard release Apr 26, 2019

dshevtsov requested review from jeff-matthews, dshevtsov and paliarush April 26, 2019 18:42

dshevtsov added 2.1.x 2.2.x 2.3.x Magento 2.3 related changes Major Update Significant original updates to existing content labels Apr 26, 2019

jeff-matthews self-assigned this Apr 26, 2019

paliarush approved these changes Apr 30, 2019

View reviewed changes

jcalcaben added the Waiting for Response Waiting for response from internal/external parties label Apr 30, 2019

jeff-matthews suggested changes May 1, 2019

View reviewed changes

jeff-matthews removed the Waiting for Response Waiting for response from internal/external parties label May 1, 2019

jeff-matthews and others added 2 commits May 2, 2019 09:28

Update guides/v2.1/coding-standards/code-standard-php.md

550fc19

Co-Authored-By: lenaorobei <oorobei@magento.com>

Apply suggestions from code review

3db62ea

Co-Authored-By: lenaorobei <oorobei@magento.com>

jeff-matthews approved these changes May 2, 2019

View reviewed changes

Merge branch 'master' into develop

ecb3eae

lenaorobei added 2 commits May 2, 2019 10:54

REPO-203: [EQP][Sniffs Consolidation] Update Magento DevDocs pages

582d8f6

- removed dead link

REPO-203: [EQP][Sniffs Consolidation] Update Magento DevDocs pages

40ad537

- fixed dead links

jeff-matthews merged commit 8fe337f into magento:master May 2, 2019

Updated corresponding pages due to with Magento Coding Standard release #4360

Updated corresponding pages due to with Magento Coding Standard release #4360

Uh oh!

Conversation

lenaorobei commented Apr 26, 2019 • edited by jeff-matthews Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of this PR

Affected URLs

Request for Review:

Uh oh!

magento-engcom-team commented Apr 26, 2019

Uh oh!

magento-cicd2 commented Apr 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

devops-devdocs commented Apr 26, 2019

Uh oh!

lenaorobei commented Apr 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

paliarush Apr 30, 2019

Choose a reason for hiding this comment

Uh oh!

lenaorobei May 2, 2019

Choose a reason for hiding this comment

Uh oh!

jeff-matthews left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lenaorobei commented May 2, 2019

Uh oh!

jeff-matthews commented May 2, 2019

Uh oh!

jeff-matthews commented May 2, 2019

Uh oh!

jeff-matthews commented May 2, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lenaorobei commented May 2, 2019

Uh oh!

jeff-matthews commented May 2, 2019

Uh oh!

ghost commented May 2, 2019

Uh oh!

Uh oh!

lenaorobei commented Apr 26, 2019 •

edited by jeff-matthews

Loading

magento-cicd2 commented Apr 26, 2019 •

edited

Loading

lenaorobei commented Apr 26, 2019 •

edited

Loading

jeff-matthews commented May 2, 2019 •

edited

Loading