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.