RichardLitt/standard-readme

Create a Standard Readme linter

开放

#5 创建于 2016年5月12日

在 GitHub 查看
 (19 条评论) (11 个反应) (0 位负责人)Shell (2,483 个派生)batch import
enhancementhelp wanted

仓库指标

星标
 (5,239 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
阅读主README中的Standard Readme规范，然后研究remark和remark lint API，创建一个检查README文件是否符合规范的linter。
技术栈
javascriptnodejs
领域
documentation
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
JavaScriptNode.jsGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65