olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 geöffnet am 3. Mai 2018

Auf GitHub ansehen
 (11 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (528 Forks)batch import
good first issuepkg: clistatus: claimedtype: feature

Repository-Metriken

Stars
 (9.168 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Die CLI verwendet wahrscheinlich einen Befehlszeilenargument Parser wie yargs oder commander. Suchen Sie im `bin/` oder `src/cli` Ordner nach dem Einstiegspunkt. Das Flag ` no markdown` sollte zu den Optionen hinzugefügt werden, und wenn es vorhanden ist, sollte `README.txt` anstelle von `README.md` geschrieben werden. Überprüfen Sie die aktuelle README Generierungslogik, um zu sehen, wo die Dateierweiterung festgelegt wird. Die vorhandenen Kommentare könnten Hinweise auf die Präferenzen der Maintainer geben.
Tech Stack
javascriptnodejs
Domain
cli
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70