olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 opened on May 3, 2018

View on GitHub
 (11 comments) (0 reactions) (0 assignees)JavaScript (528 forks)batch import
good first issuepkg: clistatus: claimedtype: feature

Repository metrics

Stars
 (9,168 stars)
PR merge metrics
 (No merged PRs in 30d)

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.

Contributor guide

Research direction
Look at the existing CLI argument parser and the function that generates README files. Add a new flag to toggle markdown output.
Tech stack
javascriptnodejs
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70