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?
I’m testing a tiny idea: “README policy as code.”
Not markdown style linting, but more of a maintainer checks:
Would this be useful in your projects?
If yes, what’s the one rule you’d want first?
i think the first qiestion i have is, what use do you see in this? because… it’s a readme file. it’s written once, maybe updated when the build process changes, but it’s generally static. what’s more, it has no required sections, many projects don’t need examples, and most things on the big forges don’t have links. it’s just a freeform document. it doesn’t even have to be markdown. rst is pretty common as well, as is plaintext. are you suggesting a tool that can parse a file of unknown format and figure out whether it contains predefined structures?