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

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.

  • permalink
  • fedilink
  • source
    •