chore(docs): add scorecard, deepwiki and socket.dev badges #227
Conversation
WalkthroughUpdates README header badges: replaced Release and License badges with a Socket Badge and DeepWiki badge; added an OpenSSF Scorecard badge; moved Release badge inline with DeepWiki; renamed Twitter badge to X with updated link. No code or exported entities changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #227 +/- ##
=======================================
Coverage 70.73% 70.73%
=======================================
Files 134 134
Lines 10884 10884
=======================================
Hits 7699 7699
Misses 3185 3185 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
5-5: Add a space between badges to avoid them collapsing.Insert a single space between the closing DeepWiki link and the opening of the Release badge so they render as two separate badges.
9-9: Align “X” badge text and site naming; fix hover text.Update the title to “@openfga on X” and (optionally) standardize references elsewhere.
-[](https://x.com/openfga) +[](https://x.com/openfga)Also consider updating the Resources entry for consistency (outside this hunk):
- - [Twitter](https://twitter.com/openfga) + - [X (formerly Twitter)](https://x.com/openfga)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Socket Security: Pull Request Alerts
🔇 Additional comments (1)
README.md (1)
7-7: Scorecard badge LGTM.Correct target and image URL. No issues.
| [](https://pypi.org/project/openfga_sdk) | ||
| [](https://github.com/openfga/python-sdk/releases) | ||
| [](./LICENSE) | ||
| [](https://socket.dev/pypi/package/openfga-sdk) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
🧩 Analysis chain
Avoid pinning Socket badge to a fixed version; also verify package slug.
Pinning to 0.9.6 will go stale and the slug uses a hyphen while PyPI/install uses an underscore. Prefer an unpinned/latest badge and confirm the correct Socket.dev path for this package.
🌐 Web query:
For Socket.dev PyPI badges:
1) What is the correct badge URL format to always show the latest version (no hardcoded version segment)?
2) For the OpenFGA Python SDK, which PyPI slug is correct for Socket.dev: `openfga_sdk` or `openfga-sdk`?
💡 Result:
Answers:
-
Use the package badge endpoint without a version segment, e.g.:
https://socket.dev/pypi/package//badge.svg
(replace with the package's PyPI slug). [1] -
The OpenFGA Python SDK’s PyPI slug is openfga-sdk (with a hyphen). [2]
Sources:
[1] Example Socket.dev PyPI package page (shows package slug in its URL path). https://socket.dev/pypi/package/abadge.
[2] OpenFGA Python SDK on PyPI: openfga-sdk. https://pypi.org/project/openfga-sdk/
Use unpinned Socket.dev PyPI badge and correct slug (openfga-sdk)
Replace the pinned badge in README.md (line 4) with the unpinned badge endpoint: https://socket.dev/pypi/package/openfga-sdk/badge.svg — the PyPI slug is openfga-sdk (hyphen), not openfga_sdk.
🤖 Prompt for AI Agents
In README.md around line 4, the Socket.dev PyPI badge is pinned and uses the
wrong slug; replace the current badge/image URL and link target to use the
unpinned badge endpoint with the correct hyphenated slug:
https://socket.dev/pypi/package/openfga-sdk/badge.svg and ensure any hyperlink
pointing to the package uses the slug openfga-sdk (with a hyphen) rather than
openfga_sdk.
aaguiarz
changed the title
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit