matthewfeickert
commented
2 years ago Along these lines, while I'm reluctant to move too many of the README bages, I can understand (totally valid) arguments like ones @phinate has made on the IRIS-HEP Slack
I generally think lots of repos have badge bloat… there’s a huge duplicity of information that is also on the same page in other forms (license, discussions tab, scikit-hep badge [because it’s under the scikit-hep org…]), and useless information (i don’t care that your repo uses a particular code formatter) and so I end up not really looking at any of them. The only important ones imo are if your CI is passing, the DOI, and link to the docs. otherwise it gives the impression of "look how fancy my repo is".
While I think DFM has very good taste, I personally would find the amount of badges on a (great) project like tinygp to be slightly too minimal for my tastes.
It might be worth trying to find a way to seperate out what are the "docs badges" (the badges used to communicate useful information to people who are coming to the GitHub repo/docs to use the projects) vs. the "dev badges" (that serve as a bit of a dashboard for the dev team).
I would argue though that if you're a user, you probably don't care if the CI is passing at HEAD (the dev team sure should though!) you should just care if the CI passed for the last release and that information is almost definitley not available in the README.
No strong opinion here, I think it is fine as-is. I personally think that the "What does it support" section is expert-level material, and that there is a lot of scrolling needed to get to the docs section, but ultimately it is just personal opinion. Users should be able to comfortably find what they are looking for with the layout implemented here.
_Originally posted by @alexander-held in https://github.com/scikit-hep/pyhf/pull/1789#discussion_r814911171_