afeld/markdown_proofer

add a command line executable

Open

#10 opened on May 11, 2016

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Ruby (2 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

Would make usage (especially in CI) easier.

/cc https://github.com/gjtorikian/html-proofer#using-on-the-command-line

Contributor guide

Research direction
Implement a command line executable for markdown proofer using a Ruby argument parser like Thor or OptionParser. Follow the example of html proofer's command line interface.
Tech stack
ruby
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RubyGem development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70