GreenStepsChatt/greensteps

Add a markdown linter

Open

#65 opened on Oct 27, 2017

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Ruby (30 forks)auto 404
help wantedready

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there something we could add to the default rake task, and have either Code Climate or Semaphore run that would validate markdown files? It would also be nice if it could check to make sure that all lines are less than 80 characters.

Contributor guide

Research direction
Find a Ruby markdown linter (e.g., mdl), add it to the Gemfile, create a Rake task, and configure Semaphore or Code Climate to run it on PRs.
Tech stack
ruby
Domain
documentation
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
RubyRakeGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75