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 (2,483 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,239 stars)
PR merge metrics
 (Avg merge 2h 3m) (1 merged PR in 30d)

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

Research direction
Read the Standard Readme specification from the main readme, then study remark and remark lint APIs to create a linter that checks README files against the spec.
Tech stack
javascriptnodejs
Domain
documentation
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
JavaScriptNode.jsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65