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

Please REMOVE most badges from the README #14837

Closed
nbro opened this issue Apr 27, 2024 · 5 comments
Closed

Please REMOVE most badges from the README #14837

nbro opened this issue Apr 27, 2024 · 5 comments

Comments

@nbro
Copy link

nbro commented Apr 27, 2024

It's so confusing. Please, put them at the end or in a dedicated section, but not at the beginning, or just remove most of them. Most people are only interested in badges that link to the documentation (I couldn't not find it - don't blame me because the README is too cluttered, even though it's short - well, that's an achievement!), the supported Java versions, and maybe the license. Well, at least, that's my case. We don't care about all the 10 different tools you use to develop. This is only useful for developers and I suppose most of them don't need to know this anyway.

@MANISH-K-07
Copy link
Contributor

@nbro , I believe this conversation is something that should happen at the discussions section :)

Issues are usually for bugs, doc updates and stuff..

@nrmancuso
Copy link
Member

Hi @nbro, as I mentioned at #14838, I mostly agree that the badges are a bit noisy, however this is a common GitHub practice and is easily ignored. We won't be removing them, but thank you for the feedback.

@romani
Copy link
Member

romani commented Apr 29, 2024

We use them to see CI state on master branch, we check state of CI on daily basis, it might be not useful for random user who opens a page. But it is very useful for maintainers and collaborators.
It is not a rare case that we have CI failure in master that unfortunately blocks all PRs.

@nbro
Copy link
Author

nbro commented Apr 29, 2024

@nrmancuso, @romani Right, but you can move them to the end. What I'm saying is that too many badges at the beginning of the README makes it very confusing to newcomers, like me. Alternatively, if you still want to keep them at the beginning, you could put them or most of them in <details> here go the badges </details>, so that they are still there if people wanted to see them

@romani
Copy link
Member

romani commented Apr 29, 2024

We will keep it for now on top, but this issue will collect feedback from users, if amount of user who supports your idea be significant , we can reconsider our decision.

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

No branches or pull requests

4 participants