olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 创建于 2018年5月3日

在 GitHub 查看
 (11 评论) (0 反应) (0 负责人)JavaScript (9,168 star) (528 fork)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
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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