nodejs / nodejs/node-core-utils
Improve documentation for ncu-config
Aperta
Nessuno ha ancora preso questa issue.
ncu-config
Priority: High
- Lingua principale
- JavaScript
- Stelle
- 314
- Fork
- 137
- Merge medio
- 2g 8h
- PR unite (30g)
- 24
Descrizione
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>
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando la documentazione di ncu-config e rivedi il riferimento di configurazione esistente. Documenta le possibili impostazioni owner, repo e readme, inclusi i comandi mostrati per usare ncu con un altro repository; il lavoro è completato quando gli utenti possono trovare e seguire questi esempi di configurazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, nodejs
- Ambito
- cli, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100