good-first-issue icon indicating copy to clipboard operation
good-first-issue copied to clipboard

[Documentation] Sugestion to Doc

Open engFelipeMonteiro opened this issue 5 years ago • 1 comments

follow parts of documentation:

To test locally, using the modules tests with npm test and trying out a few different commands (like the selector, a specific project, a failed project, and so on) is recommended. For example:

npm i -g # This assumes your current working directory is the module's directory
good-first-issue # run the interactive CLI
good-first-issue react # test the react project
good-first-issue node # test the Node.js project
good-first-issue github # test the GitHub organization, `github`
good-first-issue github/semantic # test the GitHub repo, `github/semantic`
good-first-issue thisisntarealprojectorgithuborg

If you run the code below, its install the repo in the path of the OS ( globally ), but don't install its dependencies, that is needed by test feature.

npm i -g #

I am working in improvement to the Doc in a separate fork.

engFelipeMonteiro avatar Oct 26 '19 14:10 engFelipeMonteiro