7
Idea validation: README quality checker for open source projects (lemmy.ml)
submitted 3 months ago by to c/opensource@programming.dev
2 comments fedilink hide all child comments
 

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 are viewing a single comment's thread
view the rest of the comments
[–] 2 points 3 months ago

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?

  • permalink
  • fedilink
  • source
    •