-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Closed
Labels
Description
I use standard to check my code, dependency-check to check my package.json deps are sane, but I don't have anything to check my readme.
I wonder if it would practical to do for node module readmes what standard did for JS style. There is a pretty cool markdown linter called markdownlint that could be used for basic style checking.
Going beyond style, though, what about failing if these cases are not met:
- readme must have a title
- title must be followed by a description
- description must be followed by a nodei.co badge
- readme must have a section titled
installation - readme must have a section titled
exampleorusage - readme must have a section titled
api apisection must have a sub section for each public method in the modules main entry- readme must have a section titled
license
so, does this seem like a good idea? what are other base requirements that should be added (or removed) from the above list?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Done