7
Idea validation: README quality checker for open source projects (lemmy.ml)
submitted 2 days ago by jksalcedo@lemmy.ml 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
[-] Sxan@piefed.zip 0 points 2 days 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.

this post was submitted on 13 Jul 2026
7 points (100.0% liked)

Opensource

6387 readers
147 users here now

A community for discussion about open source software! Ask questions, share knowledge, share news, or post interesting stuff related to it!

CreditsIcon base by Lorc under CC BY 3.0 with modifications to add a gradient

⠀

founded 2 years ago
MODERATORS
pylapp@programming.dev