Adding static analysis topic from wiki #8547
Conversation
dobooth
added
2.3.x
There was a problem hiding this comment.
This is an excellent new Topic. The instructions are very clear and concise. I checked a few locations for the settings and the instructions were spot on. I am unable to fully check all the technical accuracies as I don't have some of the features installed on my MAC (I am not a developer)
A second review by a Technical Architect for might be recommended.
|
|
||
| ## Before you begin | ||
|
|
||
| If you haven't already, make sure that node and npm are installed. Then, in the Magento root directory, run `npm install`. After installation, ensure there is a `node_modules` directory in the root of your project before proceeding. |
There was a problem hiding this comment.
| If you haven't already, make sure that node and npm are installed. Then, in the Magento root directory, run `npm install`. After installation, ensure there is a `node_modules` directory in the root of your project before proceeding. | |
| If you haven't already, make sure that Node and NPM are installed. Then, in the Magento root directory, run `npm install`. After installation, ensure there is a `node_modules` directory in the root of your project before proceeding. |
There was a problem hiding this comment.
Those are generally accepted as lowercase.
There was a problem hiding this comment.
In that case (please add @hguthrie's suggestion for emphasis)
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: ready for review
labels
Co-authored-by: Barny Shergold <[email protected]>
Co-authored-by: Barny Shergold <[email protected]>
Co-authored-by: Barny Shergold <[email protected]>
m2-community-project
bot
added
Progress: review
and removed
Progress: changes requested
labels
|
|
||
| ## Before you begin | ||
|
|
||
| If you haven't already, make sure that node and npm are installed. Then, in the Magento root directory, run `npm install`. After installation, ensure there is a `node_modules` directory in the root of your project before proceeding. |
There was a problem hiding this comment.
In that case (please add @hguthrie's suggestion for emphasis)
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: review
labels
There was a problem hiding this comment.
YAY! Good instructions. 🏆
Made a few suggestions for consistency and for style, but there was nothing egregious. I made a guess on a few things, so double check.
It is optional, but you can use the procedure title convention to state what the steps do. "To install blah blah:" for example. You can find that usage in the style guide.
Co-authored-by: hguthrie <[email protected]>
m2-community-project
bot
added
Progress: review
and removed
Progress: changes requested
labels
|
running tests |
|
Hi @dobooth, thank you for your contribution! |
Purpose of this pull request
This pull request (PR) adds a document about setting up static analysis that was going private to do magento-commerce changes. Wanted to keep the info available.
Affected DevDocs pages
https://devdocs.magento.com/guides/v2.4/test/static/static-analysis.html
whatsnew
Added the Setting up static analysis topic.