Readability concern with the new beman lifetime notation

This originates from: beman.exemplar: change library status to under development (exemplar is a template library) by neatudarius · Pull Request #89 · bemanproject/exemplar · GitHub

The current lifetime notation in README file of all projects have readability issue.

Screenshot from @neatudarius



These are the icons in question:


How it shows up on exemplar from chrome on my end with 100% zoom:

How it shows up on GitHub Mobile:

The text under the icons:

  • Is entirely unreadable under darkmode
  • Is too small to read on web browser
  • Is too small to read on GitHub Mobile

The color of the icon:

  • May blend into the dark-mode background

The icon itself breaks up the formatting of the introduction section of a project.

I think we should have a consistent & standardized badge for the maturity model, and prefer to use it at the start of README files over the cute dragon icons.

e.g.

1 Like

I’d be happy to drop the icons. I don’t think they’re necessary.

1 Like

I do think we should come up with a consistent badge though. They are very helpful.

I haven’t found badges to be useful myself. Whenever I see them on projects, they’re “passing” so it doesn’t provide any useful additional information.

I will tackle more ideas from this thread and do some experiments as subtasks for Create a Beman library maturity model · Issue #77 · bemanproject/beman · GitHub

I actually like the icons – once you know the system you don’t have to read the words. And aren’t the words actually always present as a backup?

edit: The words Status: .... are clearly there even in the problematic samples.

Thanks darius! My personal suggestion would be to have a consistent badge style + wording.

Yes, the words are always present. But personally I think introductions to projects are most important for people browsing / checking out. The less “what is this”, the more dense with summaries, the better.

Once you know the system, badges/ icons work the same as long as they are designed to be easily readable. Which I argue badges are easier to be made readable than icons, at least at current state.

I partially share this. You would realize a project might be having issue if the badge is no longer “passing”, and you would know there’s some reasonable CI (which may imply tests) when they are showing as “passing”.

In node/ python projects they often use badges to indicate the minimum node/ python version supported, also the latest version of the underlying project, which is helpful at a glance. At least for me, my eyes lands on the titles first, badges second, then the later descriptions.

But yeah I definitely agree that they are overused, especially CI badges. I would not disagree if the consensus falls to “we should just not have either badge nor icon”. But I think badges are a better alternative to the current icon situation.

TLDR: We decided to replace logos with badges in individual repo README files.

offtopic, @river , please move this topic to “Beman Development” (this is not a library discussion).

1 Like