RichardLitt/standard-readme

Create a Standard Readme linter

Open

#5 ouverte le 12 mai 2016

Voir sur GitHub
 (19 commentaires) (11 réactions) (0 assignés)Shell (5 239 stars) (2 483 forks)batch import
enhancementhelp wanted

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.

Guide contributeur

Stack technique
javascriptnodejs
Domaine
toolingdeveloper experiencedocumentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of Node.jsFamiliarity with remark and remark lint
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.