Update status badges - Githubissues

skypyproject / skypy

SkyPy: A package for modelling the Universe.

BSD 3-Clause "New" or "Revised" License

118 stars 38 forks source link

Update status badges #441

Closed rrjbca closed 3 years ago

rrjbca commented 3 years ago

Description

See updated README here

Add JOSS status badge
Move status badges to appropriate subsections in the README to reduce clutter

Checklist

[x] Follow the Contributor Guidelines
[ ] Write unit tests
[ ] Write documentation strings
[ ] Assign someone from your working team to review this pull request
[x] Assign someone from the infrastructure team to review this pull request

ntessore commented 3 years ago

no point in adding the JOSS badge unless it's accepted
I get the urge to remove clutter, but the entire point of the badges is to have them at the top of the README for a quick glance. Instead of moving them you might as well remove them and replace with a blurb of text.

rrjbca commented 3 years ago

The JOSS badge would update on being accepted (which I recognise could not happen). Regarding clutter the specific issue I had was that adding JOSS made the badges spill over onto a second line on my screen. They do also seem to split naturally into groups; DOIs, Distributions, and Testing (+Docs?). Probably preferable to keep the DOI badges on the front page though rather than getting lost in the CITATION page.

rrjbca commented 3 years ago

Perhaps let's keep the PR open and reconsider merging once the JOSS paper is published?

ntessore commented 3 years ago

In the end, now with the badges under individual headlines, it is easily identifiable on the actual page so happy to accept once JOSS goes through. Or we accept it now and own our loss in case it doesn't get accept.