python-package-template icon indicating copy to clipboard operation
python-package-template copied to clipboard

docs: rearrange and rename and add badges to meet current feature set

Open jenstroeger opened this issue 3 years ago • 8 comments

Just playing around with badges, which ones we want to show and how…

license pre-commit conventional-commits black bandit codeql mypy flake8 pylint pytest hypothesis coverage

Here I focused more on the area and feature sets this repo offers, instead of having the badge show details for the specific feature.

Should we add a badge for SLSA level 1*, too (see issue https://github.com/jenstroeger/python-package-template/issues/25) — slsa

What about a Scorecard badge (see issue https://github.com/jenstroeger/python-package-template/issues/32) — is that a code qa badge, or ci?

What about the OSSF Best Practices badge (see issue https://github.com/jenstroeger/python-package-template/issues/121) — is that a code qa badge, or ci?

————— * We haven’t quite reached level 2 yet, have we?

jenstroeger avatar Jun 22 '22 00:06 jenstroeger

And for laffs & giggles we could consider using the LGBT Flag colors ☺️

jenstroeger avatar Jun 22 '22 02:06 jenstroeger

We can also add this SLSA badge now.

behnazh avatar Aug 02 '22 22:08 behnazh

We can also add this SLSA badge now.

That’s an SVG with an embedded data URL for the logo*. So, using the shields.io badges we already use I guess we can mimic that badge: slsa

That logo would deviate though from the pattern I considered establishing, where a badge has a “type” on the left (e.g. “security” or “ci”) and a value on the right (e.g. “bandit” and “CodeQL” for the “security” badge). The SLSA would be a “ci” badge, maybe?

————— * I suggested to the SLSA folks to submit their logo to Simple Icons to make it available through a slug: https://github.com/slsa-framework/slsa/issues/457

jenstroeger avatar Aug 02 '22 23:08 jenstroeger

And now this repo also supports pip-audit: pip-audit

jenstroeger avatar Nov 02 '22 07:11 jenstroeger

I rebased an updated this PR:

licensepre-commit conventional-commitsblackbandit codeql pip-auditslsamypy flake8 pylintpytest hypothesis coverage

jenstroeger avatar Feb 12 '23 05:02 jenstroeger

Oh, and Github can also create badges from workflow runs! @behnazh should we add the badges for a few of our important workflows, for example

Check and Release

CodeQL

Scorecards supply-chain security

jenstroeger avatar Feb 26 '23 12:02 jenstroeger

The actual Scorecard badge with current score: OpenSSF
Scorecard

jenstroeger avatar May 07 '23 20:05 jenstroeger

Looks like the Conventional Commits folks provide their own badge: Conventional Commits

jenstroeger avatar May 14 '23 06:05 jenstroeger