olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 opened on 2018年5月3日

GitHub で見る
 (11 comments) (0 reactions) (0 assignees)JavaScript (9,168 stars) (528 forks)batch import
good first issuepkg: clistatus: claimedtype: feature

説明

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.

コントリビューターガイド

技術スタック
javascriptnodejs
領域
clitooling
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Node.jsCLI developmentJavaScript
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
The CLI likely uses a command line argument parser like yargs or commander. Look into the `bin/` or `src/cli` folder for the entry point. The flag ` no markdown` should be added to the options, and when present, write `README.txt` instead of `README.md`. Check the current README generation logic to see where the file extension is set. The existing comments may provide guidance on maintainer preferences.
Add flag to CLI to generate text READMEs · olistic/warriorjs#47 | Good First Issue