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

Beman library maturity model: express status using an extra badge (additional to LIBRARY_STATUS rule) #84

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

neatudarius
Copy link
Member

@neatudarius neatudarius commented Jan 16, 2025

  • Add SVG badges
  • Update LIBRARY_STATUS rule to also indicate usage or badges

Expected badges:
image

Expected usage example:
image

@neatudarius neatudarius changed the title Beman maturity model: Add static SVG badgesa Beman maturity model: Add static SVG badges Jan 16, 2025
@neatudarius neatudarius changed the title Beman maturity model: Add static SVG badges Beman library maturity model: express status using a badge Jan 16, 2025
@neatudarius neatudarius marked this pull request as ready for review January 16, 2025 19:30
@neatudarius
Copy link
Member Author

@JeffGarland , can you please help here with a quick decision it is related to style?

Context:

  1. We have a poll which says we want badges instead of logos. And we want badges to be present in each repo.
  2. I was wondering if we can remove the line with Status: ... and avoid duplication. Merge this information with a generic mention near the badge.

I'm fine with either option:
V1: put badges and keep Status: ... line
V2: put badges and remote Status: ... line

@JeffGarland
Copy link
Member

and avoid duplication

We should do both, because it isn't useless duplication -- it's two different ways of communicating. Good human factors design for visual displays will often provide both text and an icon with color. The duplication is in recognition that some significant portion of the population has different color perception (see also colorblindness -- which really refers to a range of vision differences among people). In this group the text will often be more effective. That said, a shape/color can confer information quickly without the need to read. So both modes do have a value.

@neatudarius neatudarius changed the title Beman library maturity model: express status using a badge Beman library maturity model: express status using an extra badge (additional to LIBRARY_STATUS rule) Jan 18, 2025
@neatudarius
Copy link
Member Author

neatudarius commented Jan 18, 2025

and avoid duplication

We should do both, because it isn't useless duplication -- it's two different ways of communicating. Good human factors design for visual displays will often provide both text and an icon with color. The duplication is in recognition that some significant portion of the population has different color perception (see also colorblindness -- which really refers to a range of vision differences among people). In this group the text will often be more effective. That said, a shape/color can confer information quickly without the need to read. So both modes do have a value.

@JeffGarland , done. Thanks!

Check latest status:
image

Library PR example: bemanproject/exemplar#89

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