Skip to content

README: the OpenSSF Best Practices badge - #168

Merged
arpanghoshal merged 1 commit into
mainfrom
readme/best-practices-badge
Sep 13, 2026
Merged

arpanghoshal merged 1 commit into
mainfrom
readme/best-practices-badge

Conversation

@arpanghoshal

@arpanghoshal arpanghoshal commented Sep 13, 2026

Copy link
Copy Markdown
Member

Adds the OpenSSF Best Practices badge to the README badge row, beside the Scorecard badge. Project 14615 at https://www.bestpractices.dev/projects/14615, registered 2026-09-13, every passing criterion answered with a URL a reader can check. The row is pasted from the generator in CTRLRun/ctrlrun-docs (PR #12 there), as the marker in the README says.

The badge image is live and shows the project's current standing; the number on it moves as the badge site re-reads the answers.

Summary by CodeRabbit

  • Documentation
    • Added an OpenSSF Best Practices badge link to the project README.

Project 14615 at bestpractices.dev, registered 2026-09-13 with every passing criterion
answered and each answer a URL a reader can check. The row is pasted from
ctrlrun-docs/generated/badges.readme.md as the marker says; the generator gained the entry in
the same change on the other side.

Signed-off-by: arpan <contact@arpanghoshal.com>
@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: fd443329-3c70-4c22-b16e-30806b0b7a6b

📥 Commits

Reviewing files that changed from the base of the PR and between b015b01 and 6d59c1c.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README badge row now includes an OpenSSF Best Practices badge link for project 14615.

Changes

README Badge Update

Layer / File(s) Summary
Add OpenSSF badge
README.md
The badge row now includes an OpenSSF Best Practices project link.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 6d59c

This documentation-only badge update is safe to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the main change: adding the OpenSSF Best Practices badge to README.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme/best-practices-badge

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@arpanghoshal
arpanghoshal merged commit 47b6cfe into main Sep 13, 2026
26 of 27 checks passed
@arpanghoshal
arpanghoshal deleted the readme/best-practices-badge branch September 13, 2026 10:23
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