RichardLitt/standard-readme

Create a Standard Readme linter

Open

#5 建立於 2016年5月12日

在 GitHub 查看
 (19 留言) (11 反應) (0 負責人)Shell (5,239 star) (2,483 fork)batch import
enhancementhelp wanted

描述

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.

貢獻者指南

技術棧
javascriptnodejs
領域
toolingdeveloper experiencedocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic understanding of Node.jsFamiliarity with remark and remark lint
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.