RichardLitt/standard-readme

Create a Standard Readme linter

Open

#5 opened on May 12, 2016

View on GitHub
 (19 comments) (11 reactions) (0 assignees)Shell (5,239 stars) (2,483 forks)batch import
enhancementhelp wanted

Description

There should be a linter, after the spec in the main readme is filled out. The linter will most likely use remark and remark-lint. This is the planning issue for the linter. Please subscribe here, and open new issues for tangential questions about Standard Readme.

Contributor guide

Tech stack
javascriptnodejs
Domain
toolingdeveloper experiencedocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of Node.jsFamiliarity with remark and remark lint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the comments in this issue for additional requirements and discussion. The issue suggests using remark and remark lint to build the linter. The main readme contains the spec to be enforced. Examine existing linter implementations for reference. The linter should be a Node.js CLI tool that parses README files and checks compliance with the standard readme spec.