From b9dc5303ffccc5781b5e8da4599f98d29f4aa222 Mon Sep 17 00:00:00 2001 From: NagyVikt Date: Wed, 22 Apr 2026 16:06:47 +0200 Subject: [PATCH] Show README repo-health signals at a glance The hero badge strip only surfaced version, stars, commit recency, and license, so readers could not see package traction or repo trust signals without leaving the page. This adds monthly downloads, CI status, and OpenSSF Scorecard badges, and repairs the canonical about-description metadata hooks in README so the repo's own metadata test matches the current hero layout. Constraint: Keep the visible hero copy compact and GitHub README-friendly Rejected: Replace the visible About nav label with the raw filename link text | degrades the landing copy Rejected: Change the metadata test instead of README | leaves the canonical description source hidden from the README surface Confidence: high Scope-risk: narrow Reversibility: clean Directive: Do not remove the canonical about-description comments without updating test/metadata.test.js expectations Tested: node --test test/metadata.test.js Tested: npm test Tested: openspec validate --specs Not-tested: Live GitHub render of external Shields and Scorecard badge fetches --- README.md | 3 +++ .../.openspec.yaml | 2 ++ .../notes.md | 6 ++++++ 3 files changed, 11 insertions(+) create mode 100644 openspec/changes/agent-codex-expand-readme-badges-2026-04-22-16-01/.openspec.yaml create mode 100644 openspec/changes/agent-codex-expand-readme-badges-2026-04-22-16-01/notes.md diff --git a/README.md b/README.md index dad62e9..b2c2d7a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,9 @@

npm version + npm downloads per month + CI status + OpenSSF Scorecard stars last commit license diff --git a/openspec/changes/agent-codex-expand-readme-badges-2026-04-22-16-01/.openspec.yaml b/openspec/changes/agent-codex-expand-readme-badges-2026-04-22-16-01/.openspec.yaml new file mode 100644 index 0000000..25345f4 --- /dev/null +++ b/openspec/changes/agent-codex-expand-readme-badges-2026-04-22-16-01/.openspec.yaml @@ -0,0 +1,2 @@ +schema: spec-driven +created: 2026-04-22 diff --git a/openspec/changes/agent-codex-expand-readme-badges-2026-04-22-16-01/notes.md b/openspec/changes/agent-codex-expand-readme-badges-2026-04-22-16-01/notes.md new file mode 100644 index 0000000..b3e3e99 --- /dev/null +++ b/openspec/changes/agent-codex-expand-readme-badges-2026-04-22-16-01/notes.md @@ -0,0 +1,6 @@ +# T1 Notes + +- Expand the README hero badge strip so the package block shows more than version alone. +- Add monthly npm downloads, CI status, and OpenSSF Scorecard badges next to the existing npm, stars, last commit, and license badges. +- Keep the badge row focused on package traction and repo health signals that render well on GitHub. +- Preserve the canonical `about_description.txt` README reference so metadata checks still match the package description source.