DAI-Lab / cookiecutter-pypackage

DAI Lab's adaptation of cookiecutter-pypackage
BSD 3-Clause "New" or "Revised" License
1 stars 5 forks source link

Add DAI-Lab repository Type badge #33

Open csala opened 5 years ago

csala commented 5 years ago

A new badge/shield should be added describing the type of repository in terms of open source maturity.

The should could be created using the shields.io service and should have the format:

{DAI-Lab icon} Type | {type value}

Where {DAI-Lab icon} is an icon with the DAI-Lab logo, and the {type value} is one of I, II, III or IV

csala commented 4 years ago

The shields.io service seems to be a good fit, but the logo ends up being too small. It also requires a huge URL (the icon needs to be embedded in it)

DAI-Lab Type Shield

An alternative is to use plain text:

DAI-Lab Type Shield

Using a longer text with the icon also looks good enough:

DAI-Lab Type Shield

We also should have some web page, README or wiki where the different repository types are explained.

micahjsmith commented 4 years ago

very cool!

perhaps @kveerama can chime in on any of these points?

kveerama commented 4 years ago

@csala @micahjsmith I wonder for number 1, if we can do a few changes, it may look better. One change is background color, and second could be creation of a silhouette of the logo explicitly for this purpose (so it wont have that much detail). I will see what we can do and come back with a proposal.

@micahjsmith I like this idea to create the repo DAI-Lab/maturity-level-badges (or similar depending on the point above) that solely contains a README.md explaining the concepts and example usage (raw code blocks of markdown)

csala commented 4 years ago

@kveerama The current logo is an already adapted version with only one color and a smoothed silhouette, but keeping some of the internal parts dark.

This would be a yet simpler version, all white, with the text changes that @micahjsmith suggested:

DAI-Lab Maturity Level

micahjsmith commented 4 years ago

text looks good but I don't think the white silhouette works, I know exactly what the DAI lab logo looks like and yet staring at this icon I can't recognize it for what it is

micahjsmith commented 4 years ago

perhaps a strong white outline, not a silhouette?

csala commented 4 years ago

Here's a test using only the outline

DAI-Lab Maturity Level

micahjsmith commented 4 years ago

This design seems fine to me, I am not leaping off my feat in excitement but I think it looks fine.