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 badges in README #10341

Merged
merged 1 commit into from
Jul 10, 2024
Merged

Conversation

PyvesB
Copy link
Member

@PyvesB PyvesB commented Jul 8, 2024

Small opinionated pass on the badges at the top of our README:

  • removed the build and contributors badges, as the exact status and counts are already displayed on the GItHub homepage.
  • updated the links of the backers and sponsors badges.
  • added a discussions badge.
  • switched the Discord logo to white for better contrast.
  • updated the daily tests badge.

@PyvesB PyvesB added the documentation Developer and end-user documentation label Jul 8, 2024
Copy link
Contributor

github-actions bot commented Jul 8, 2024

Messages
📖 ✨ Thanks for your contribution to Shields, @PyvesB!
📖

Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS against 11f1ee9

<img src="https://img.shields.io/github/discussions/badges/shields" /></a>
<a href="https://github.com/badges/shields/actions/workflows/daily-tests.yml">
<img src="https://img.shields.io/github/actions/workflow/status/badges/shields/daily-tests.yml?label=daily%20tests"
alt="Daily Tests Status"></a>
Copy link
Member

Choose a reason for hiding this comment

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

i think this is the only one i'd push back on, as i'm still not a big fan of framing these as daily tests (and yes I know that nomenclature is already part of our vocabulary elsewhere)

setting aside that these have been executed on a different, greater than daily frequency, i think there's some value in reusing the "service test" verbiage that's utilized elsewhere so that contributors may perhaps more easily realize there's a connection when they see tests failing locally or in their PR

I don't feel terribly strongly about this though, especially if you and Chris prefer the daily test framing. just my .02 that we should be moving away from that framing instead of emphasizing it more 🤷

Copy link
Member Author

@PyvesB PyvesB Jul 9, 2024

Choose a reason for hiding this comment

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

I don't remember whether this was the case with the old "daily tests", but the new workflow in daily-tests.yml runs more than just the service tests, it runs the core, entrypoint, package, and integration tests as well. If feels odd to me to narrow down the badge's label to a subset of what it's actually keeping track of. Maybe something like full test suite would better represent what's being built underneath the hood?

Copy link
Member

Choose a reason for hiding this comment

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

yeah i think full test suite would be a more accurate label

The more I thought about this recurring execution of tests today the more I realized I was stumbling into a can of worms that I don't think should be addressed here so I'll go ahead and 👍 and open a new issue to pose some thoughts/questions for discussion

@PyvesB PyvesB added this pull request to the merge queue Jul 10, 2024
Merged via the queue into badges:master with commit 15edd79 Jul 10, 2024
24 checks passed
@PyvesB PyvesB deleted the badges-in-readme-update branch July 10, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Developer and end-user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants