Skip to content
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

update readme badges #273

Merged
merged 6 commits into from
Jul 12, 2022
Merged

update readme badges #273

merged 6 commits into from
Jul 12, 2022

Conversation

bjlittle
Copy link
Member

@bjlittle bjlittle commented Jul 12, 2022

🚀 Pull Request

Description

This PR updates and refreshes the README.md badges.

Notably, badges to the GHA CI and RTD have been added, and the badge to the now defunct cirris-ci has been removed.

The changes render as follows:

image

See here.

@bjlittle bjlittle requested a review from trexfeathers July 12, 2022 12:09
Copy link
Collaborator

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're not gonna like this 😅

I'm quite strongly against using HTML in markdown files unless it's absolutely necessary. It's not consistent with the ​.md​ format, and is harder to read.

I appreciate that this is the only way to get centralised text/badges, but I just don't think it's worth it. That's why I introduced markdown badges in #179 a year ago (which you were happy to merge).

It would also obvs be way easier for me to review this if the format was consistent.

@bjlittle
Copy link
Member Author

I personally don't mind HTML within Markdown, particularly when Markdown simply can't do the job.

So now we have this instead...

image

😞

@trexfeathers
Copy link
Collaborator

I personally don't mind HTML within Markdown, particularly when Markdown simply can't do the job.

So now we have this instead...

😞

Sounds like we both have strong opinions. I'll happily bow to a third opinion from another dev (which would make it a quorum either way).

@bjlittle
Copy link
Member Author

bjlittle commented Jul 12, 2022

@trexfeathers I honestly don't greatly mind. Tis fine 👍

Copy link
Collaborator

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Badges look good to me, and feel free to try alternatives to the commas.

Codacy has also picked up some boo boos I made in my original reformatting. Could you address those?

@bjlittle
Copy link
Member Author

So we now have this...
image

@trexfeathers trexfeathers merged commit a686aae into SciTools:main Jul 12, 2022
@bjlittle bjlittle deleted the add-badges branch July 12, 2022 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants