If my understanding of the awesome/headings
rule is correct, it checks to see whether the first line of the readme is a level 1 heading (#
). Some awesome-*
repositories use an image as their heading instead, including the awesome list about awesome lists. This results in a false-positive.
A reproducible example is awesome-jamstack. You can see the build failing here.
I understand that it would be difficult to check whether an image contains a headline etc. Trying to do that might present a whole set of problems/challenges.
Maybe we could enforce the rule by default but then create an option to disable it. If someone creates a repo without a heading and then runs the linter, they will see the error. If they do have a header, just in a different format, they can find the documentation and disable the error. (Allowing the linter to succeed on CI, enabling an easier collaborative experience.)
Pay now to fund the work behind this issue.
Get updates on progress being made.
Maintainer is rewarded once the issue is completed.
You're funding impactful open source efforts
You want to contribute to this effort
You want to get funding like this too