nodejs / nodejs/node-core-utils

Improve documentation for ncu-config

Ouverte
#258 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

ncu-config Priority: High
Langage dominant
JavaScript
Étoiles
314
Forks
137
Merge moyen
2 j 8 h
PR mergées (30 j)
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>

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser la documentation de ncu-config et examinez la référence de configuration existante. Documentez les paramètres possibles owner, repo et readme, y compris les commandes indiquées pour utiliser ncu avec un autre dépôt ; le travail est terminé lorsque les utilisateurs peuvent trouver et suivre ces exemples de configuration.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, nodejs
Domaine
cli, documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.