olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 ouverte le 3 mai 2018

Voir sur GitHub
 (11 commentaires) (0 réactions) (0 assignés)JavaScript (528 forks)batch import
good first issuepkg: clistatus: claimedtype: feature

Métriques du dépôt

Stars
 (9 168 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Level READMEs in markdown format could be great if you're using some kind of markdown processor to read them. If you're not planning on doing so, having the markdown syntax laying around creates noise. Running warriorjs --no-markdown should take care of that, and output to README.txt instead of README.md.

Guide contributeur

Direction de recherche
La CLI utilise probablement un analyseur d'arguments en ligne de commande comme yargs ou commander. Cherchez le point d'entrée dans le dossier `bin/` ou `src/cli`. L'option ` no markdown` doit être ajoutée aux options et, lorsqu'elle est présente, écrire `README.txt` au lieu de `README.md`. Vérifiez la logique actuelle de génération du README pour voir où l'extension de fichier est définie. Les commentaires existants peuvent fournir des conseils sur les préférences des mainteneurs.
Stack technique
javascriptnodejs
Domaine
cli
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitNode.js
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70