Skip to content

docs(readme): add standardized status & security badges#22

Open
ashu-tosh-kumar wants to merge 1 commit into
developmentfrom
chore/standardize-badges
Open

docs(readme): add standardized status & security badges#22
ashu-tosh-kumar wants to merge 1 commit into
developmentfrom
chore/standardize-badges

Conversation

@ashu-tosh-kumar

Copy link
Copy Markdown
Owner

Adds the standardized README badge set as part of cross-repo SDLC standardization.

Badges added

  • License + OpenSSF Scorecard (core, every repo)
  • Project-type-specific badges (PyPI version/downloads, CI status, code style, browser-store metrics, etc. as applicable)

Note

  • The OpenSSF Scorecard badge populates a score once the Scorecard workflow has run on the default branch (i.e. after the security-baseline PR is merged).
  • The OpenSSF Best Practices badge is left as a commented-out placeholder — it needs the repo registered at https://www.bestpractices.dev/en/projects/new first, then swap PROJECT_ID and uncomment.

🤖 Generated with Claude Code

Add the standardized README badge set (license, OpenSSF Scorecard, plus
project-type-specific badges). OpenSSF Best Practices badge left as a commented
placeholder pending project registration at bestpractices.dev.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

docs(readme): add standardized status & security badges

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Add standardized README badges for package status, installation, and code style.
• Include license and OpenSSF Scorecard security posture badges.
• Leave OpenSSF Best Practices badge as a commented placeholder pending registration.
Diagram

graph TD
  R["README.md"] --> S{{"shields.io badges"}} --> P["PyPI metrics"]
  R --> S --> G["GitHub (license)" ]
  R --> S --> O["OpenSSF Scorecard" ]
Loading
High-Level Assessment

The approach (standard markdown badges via shields.io plus direct links to authoritative sources) is the simplest, most portable way to standardize repository README status and security indicators; no materially better alternative is warranted for this change.

Files changed (1) +10 / -0

Documentation (1) +10 / -0
README.mdAdd standardized status, packaging, and security badges +10/-0

Add standardized status, packaging, and security badges

• Adds a block of README badges covering PyPI version/pyversions/downloads, installation via Homebrew, license, formatting/tooling (black, pre-commit), and OpenSSF Scorecard. Includes a commented OpenSSF Best Practices badge placeholder to enable later once the project is registered.

README.md

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds several badges (such as PyPI, Python, Downloads, Homebrew, License, Code style, pre-commit, and OpenSSF Scorecard) to the top of the README.md file. The reviewer suggested grouping these badges on a single line to ensure consistent inline rendering across various Markdown parsers.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +3 to +10
[![PyPI](https://img.shields.io/pypi/v/command-storage?style=flat-square)](https://pypi.org/project/command-storage/)
[![Python](https://img.shields.io/pypi/pyversions/command-storage?style=flat-square)](https://pypi.org/project/command-storage/)
[![Downloads](https://img.shields.io/pypi/dm/command-storage?style=flat-square)](https://pypi.org/project/command-storage/)
[![Homebrew](https://img.shields.io/badge/install-brew-informational?style=flat-square&logo=homebrew&logoColor=white)](https://github.com/ashu-tosh-kumar/homebrew-command-storage)
[![License: MIT](https://img.shields.io/github/license/ashu-tosh-kumar/command-storage?style=flat-square&color=blue)](LICENSE)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000?style=flat-square)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/ashu-tosh-kumar/command-storage?style=flat-square&label=openssf%20scorecard)](https://scorecard.dev/viewer/?uri=github.com/ashu-tosh-kumar/command-storage)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To ensure that all badges render inline next to each other consistently across all Markdown parsers (such as GitHub, PyPI's warehouse renderer, and local IDE renderers), it is highly recommended to group them on a single line or separate them with a single space rather than placing each on a new line. Some parsers may interpret consecutive newlines as line breaks or separate block elements, which can disrupt the visual alignment of the badges.

Suggested change
[![PyPI](https://img.shields.io/pypi/v/command-storage?style=flat-square)](https://pypi.org/project/command-storage/)
[![Python](https://img.shields.io/pypi/pyversions/command-storage?style=flat-square)](https://pypi.org/project/command-storage/)
[![Downloads](https://img.shields.io/pypi/dm/command-storage?style=flat-square)](https://pypi.org/project/command-storage/)
[![Homebrew](https://img.shields.io/badge/install-brew-informational?style=flat-square&logo=homebrew&logoColor=white)](https://github.com/ashu-tosh-kumar/homebrew-command-storage)
[![License: MIT](https://img.shields.io/github/license/ashu-tosh-kumar/command-storage?style=flat-square&color=blue)](LICENSE)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000?style=flat-square)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/ashu-tosh-kumar/command-storage?style=flat-square&label=openssf%20scorecard)](https://scorecard.dev/viewer/?uri=github.com/ashu-tosh-kumar/command-storage)
[![PyPI](https://img.shields.io/pypi/v/command-storage?style=flat-square)](https://pypi.org/project/command-storage/) [![Python](https://img.shields.io/pypi/pyversions/command-storage?style=flat-square)](https://pypi.org/project/command-storage/) [![Downloads](https://img.shields.io/pypi/dm/command-storage?style=flat-square)](https://pypi.org/project/command-storage/) [![Homebrew](https://img.shields.io/badge/install-brew-informational?style=flat-square&logo=homebrew&logoColor=white)](https://github.com/ashu-tosh-kumar/homebrew-command-storage) [![License: MIT](https://img.shields.io/github/license/ashu-tosh-kumar/command-storage?style=flat-square&color=blue)](LICENSE) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000?style=flat-square)](https://github.com/psf/black) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/ashu-tosh-kumar/command-storage?style=flat-square&label=openssf%20scorecard)](https://scorecard.dev/viewer/?uri=github.com/ashu-tosh-kumar/command-storage)

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.

1 participant