cutenode / cutenode/good-first-issue

[Documentation] Sugestion to Doc

Open
#168 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
832
Forks
236
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Research direction

Locate the documentation section covering local testing and compare it with the npm commands and CLI examples in the issue. Verify the installation and dependency instructions with npm test and the listed selectors; done when the documentation accurately explains the required setup and commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.