Skip to content

idea: standard-readme #141

@max-mapper

Description

@max-mapper

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 example or usage
  • readme must have a section titled api
  • api section 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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions