Skip to content

Comments

fix: Socket Badge link in README.md#257

Merged
SoulPancake merged 1 commit intoopenfga:mainfrom
manuel-lang:patch-1
Feb 22, 2026
Merged

fix: Socket Badge link in README.md#257
SoulPancake merged 1 commit intoopenfga:mainfrom
manuel-lang:patch-1

Conversation

@manuel-lang
Copy link
Contributor

@manuel-lang manuel-lang commented Feb 21, 2026

Description

The Socket Badge currently isn't displayed correctly in the README. I guess that this isn't on purpose.

What problem is being solved?

Just a minor fix to display it correctly by adding a missing parenthesis.

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

  • Documentation
    • Corrected Markdown formatting in the README to ensure proper rendering and functionality of the Socket badge link.

@manuel-lang manuel-lang requested a review from a team as a code owner February 21, 2026 11:03
Copilot AI review requested due to automatic review settings February 21, 2026 11:03
@manuel-lang manuel-lang requested review from a team as code owners February 21, 2026 11:03
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 21, 2026

Walkthrough

Fixes Markdown formatting for a Socket badge in README.md by correcting invalid link syntax. Changes an improperly formatted link to valid fenced-style link syntax with no functional impact.

Changes

Cohort / File(s) Summary
Documentation
README.md
Corrected Markdown formatting for Socket badge link by fixing missing closing bracket and repositioning URL to valid syntax.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix: Socket Badge link in README.md' clearly and specifically describes the main change: fixing a Socket Badge link in the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.17%. Comparing base (0b56a83) to head (6d5d03b).

❌ Your project status has failed because the head coverage (71.17%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #257   +/-   ##
=======================================
  Coverage   71.17%   71.17%           
=======================================
  Files         137      137           
  Lines       11100    11100           
=======================================
  Hits         7900     7900           
  Misses       3200     3200           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dosubot
Copy link

dosubot bot commented Feb 21, 2026

Related Documentation

Checked 8 published document(s) in 1 knowledge base(s). No updates required.

How did I do? Any feedback?  Join Discord

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request fixes a syntax error in the Socket Badge link in the README.md file by adding a missing closing parenthesis, ensuring the badge displays correctly.

Changes:

  • Fixed malformed Markdown badge syntax for the Socket Badge on line 4 of README.md

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

4-4: LGTM — Markdown syntax is now correct.

The fix properly closes the image link wrapper, making the badge both render and navigate correctly.

Consider using socket.dev's versionless badge endpoint: The badge image URL currently hardcodes version 0.9.9. Socket.dev supports a versionless endpoint that automatically resolves to the latest analysis—https://socket.dev/api/badge/pypi/package/openfga-sdk—which would eliminate the need to update the version after each release. The rest of the badge (line 4) would remain unchanged.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 4, Update the Socket.dev badge URL in the README by
replacing the hardcoded versioned image URL
"https://badge.socket.dev/pypi/package/openfga-sdk/0.9.9" inside the markdown
badge "[![Socket Badge](...)](...)" with the versionless endpoint
"https://socket.dev/api/badge/pypi/package/openfga-sdk" so the badge
automatically reflects the latest analysis without manual updates while keeping
the surrounding markdown link target unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 4: Update the Socket.dev badge URL in the README by replacing the
hardcoded versioned image URL
"https://badge.socket.dev/pypi/package/openfga-sdk/0.9.9" inside the markdown
badge "[![Socket Badge](...)](...)" with the versionless endpoint
"https://socket.dev/api/badge/pypi/package/openfga-sdk" so the badge
automatically reflects the latest analysis without manual updates while keeping
the surrounding markdown link target unchanged.

Copy link
Member

@SoulPancake SoulPancake left a comment

Choose a reason for hiding this comment

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

Thanks a lot @manuel-lang

@SoulPancake SoulPancake added this pull request to the merge queue Feb 22, 2026
Merged via the queue into openfga:main with commit fc2de18 Feb 22, 2026
23 of 24 checks passed
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.

3 participants