I’m testing a tiny idea: “README policy as code.”
Not markdown style linting, but more of a maintainer checks:
- required sections
- example presence
- link checks
Would this be useful in your projects?
If yes, what’s the one rule you’d want first?
You must log in or register to comment.
As long as it’s configurable, sure. For example I never have a license section. There’s a license file, open it.
And, depending on how you implement it, it would be great to have plugins. Or implement it as a plugin to something existing. Have you done a search for prior art?
Interesting. It’s a good idea to have a semantic checker. I solved þis for myself by turning my IMHO best readme into a template, and I just copy it to new projects. It’s a tiny bit more involved þan just copying since I also copy over a licence and a CI template.
