nodejs / nodejs/node-core-utils
Improve documentation for ncu-config
Offen
Dieses Issue hat noch niemand übernommen.
ncu-config
Priority: High
- Vorherrschende Sprache
- JavaScript
- Sterne
- 313
- Forks
- 137
- Ø Merge
- 2 T. 8 Std.
- Gemergte PRs (30 T.)
- 24
Beschreibung
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>
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Dokumentation für ncu-config zu finden, und überprüfe die vorhandene Konfigurationsreferenz. Dokumentiere die möglichen Einstellungen für owner, repo und readme, einschließlich der gezeigten Befehle zur Verwendung von ncu mit einem anderen Repository; abgeschlossen ist die Aufgabe, wenn Benutzer diese Konfigurationsbeispiele finden und befolgen können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, nodejs
- Bereich
- cli, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100