MetaMask / module-lint

Analyzes one or more repos for divergence from a template repo.
1 stars 3 forks source link

Add README-related checks #53

Open mcmire opened 5 months ago

mcmire commented 5 months ago

For a given project, we want to ensure that:

mcmire commented 5 months ago

In order to work on this ticket, we will probably have to parse the README using a Markdown parser. I am thinking remark or markdown-it, but there may be others. I might create a new research ticket for this if we feel the need.

mcmire commented 5 months ago

Also note that there is some overlap between this ticket and #12, in that we already have a rule which looks for Node installation instructions in the README. We may want to tweak this rule, however, to account for whichever version is listed in .nvmrc and/or lack of .nvmrc.