RichardLitt/standard-readme

Create a Standard Readme linter

Open

#5 opened on 2016年5月12日

GitHub で見る
 (19 comments) (11 reactions) (0 assignees)Shell (5,239 stars) (2,483 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.