nodejs / nodejs/node-core-utils
Improve documentation for ncu-config
Open
Nobody has claimed this yet.
ncu-config
Priority: High
- Dominant language
- JavaScript
- Stars
- 314
- Forks
- 137
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 24
Description
Documentation for ncu-config don't show possible configs. For example, to use ncu on other Org. repositories you need to:
ncu-config set owner <owner>
ncu-config set repo <repo>
ncu-config set readme <local path to nodejs/node README.md>
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for ncu-config and review the existing configuration reference. Document the possible owner, repo, and readme settings, including the shown commands for using ncu with another repository; done means users can discover and follow these configuration examples.
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