Skip to content

docs: add OpenSSF badge and Matrix channel badge#187

Merged
mrbrandao merged 2 commits into
LobsterTrap:mainfrom
mrbrandao:docs/openssf-badge
Jun 10, 2026
Merged

docs: add OpenSSF badge and Matrix channel badge#187
mrbrandao merged 2 commits into
LobsterTrap:mainfrom
mrbrandao:docs/openssf-badge

Conversation

@mrbrandao

@mrbrandao mrbrandao commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds the OpenSSF Best Practices passing badge to README.md
  • Adds the Matrix channel badge linking to #lola-ai:matrix.org

Details

Both badges appear at the top of the README for immediate visibility:

Part of the AAIF readiness work.

Summary by CodeRabbit

  • Documentation
    • Added OpenSSF Best Practices and Matrix status badges to the project README.
    • Badges link to their respective project pages to surface security best-practices compliance and community matrix information for end users.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: dbb9df57-b470-443d-9351-a80b7d375014

📥 Commits

Reviewing files that changed from the base of the PR and between a901f96 and 2942184.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Three lines are added to the README header: OpenSSF Best Practices and Matrix badges, each linking to their respective external project pages. No code, APIs, or public interfaces are changed.

Changes

README Documentation Enhancement

Layer / File(s) Summary
README badges for OpenSSF and Matrix
README.md
OpenSSF Best Practices and Matrix badges are added to the README header with external links to the corresponding project pages.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • LobsterTrap/lola#152: Both PRs update documentation in README.md to add badges/links to a code-of-conduct-related policy file.
  • LobsterTrap/lola#151: Both PRs only update documentation in README.md by adding badges/links to security-related info.

Suggested labels

documentation

Suggested reviewers

  • SecKatie
  • rjeffman
  • sergio-correia

Poem

🐰 I hopped into README to add a little shine,
Two badges to welcome the guard and the line,
OpenSSF and Matrix, now side by side,
A tiny celebration, a joyful README pride! 🎉

🚥 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 accurately describes the main change: adding two badges (OpenSSF and Matrix) to the README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Stopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a @coderabbit review after the pipeline has finished.


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 and usage tips.

@mrbrandao mrbrandao requested a review from rjeffman June 9, 2026 17:58
@mrbrandao mrbrandao added the documentation Improvements or additions to documentation label Jun 9, 2026

@rjeffman rjeffman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm

@mrbrandao mrbrandao merged commit 279d87c into LobsterTrap:main Jun 10, 2026
6 checks passed
@mrbrandao mrbrandao deleted the docs/openssf-badge branch June 10, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants