-
Notifications
You must be signed in to change notification settings - Fork 49
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
reorganise readme badges #352
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks cool, they are much less bewildering when grouped like that.
Some possible additions, and is it finicky to suggest different orderings ?
After some thought, changes I think I might make:
- move 'ci-tests' to front of CI section, as I think its the most important entry
- sections order : put "community" under "repo", and "package" last (as it's effectively a download link reference).
- actually I'm not sure about 'Community'. If we had a code-of-conduct badge it could go there, but the DOI as we have it is version-specific : so that could just go in 'package'.
- didn't we have a badge for "platform: agnostic" package type? -- would go in 'package' section (not in Meta)
- include "imports: isort" in the Meta section -- this one seems to have disappeared, was there a reason for that ?
I'm a bit puzzled because I think it may have changed under my feet while I was writing some notes, but I can't quite see how !
It is, but I've put them in alphabetical order, otherwise they're just random. I agree
The sections are ordered alphabetically, otherwise it's a bit random. Once we agree on the CoC poll then the badge for that will go in the
For me, the community reference the DOI to cite us. That's my thinking on it, but happy to move it to the package 👍
I'll re-add those 👍
|
Sorry, don't quite know what I was thinking there. |
Thanks @bjlittle , clearly an improvement ! |
@pp-mo Awesome, thanks 🚀 |
🚀 Pull Request
Description
This PR reorganises the
README.md
badges into the following: