kefranabg/readme-md-generator

Available Scripts

Open

#41 aperta il 14 giu 2019

Vedi su GitHub
 (10 commenti) (0 reazioni) (1 assegnatario)JavaScript (1349 fork)batch import
enhancementgood first issue

Metriche repository

Star
 (10.735 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

What do you think about a session Available Scripts? Getting all your scrpts commands on package.json file. Like generated apps with create-react-app.

If is ok I can try to do this.

Guida contributor

Direzione di ricerca
Esamina la logica esistente di generazione del README nel repository (probabilmente in src/index.js o simile). Identifica come vengono aggiunte altre sezioni (come 'Usage', 'Installation') all'output. Quindi, analizza il file package.json nella directory del progetto per estrarre l'oggetto 'scripts'. Formatta gli script come un elenco (ad esempio, punti elenco o tabella) e includili nel README generato. Controlla i commenti dell'issue per eventuali requisiti aggiuntivi o suggerimenti dei maintainer.
Tech stack
javascriptnodejs
Dominio
cli
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitNode.jsnpm
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80