chore(docs): add scorecard, deepwiki and socket.dev badges#260
Conversation
WalkthroughREADME updated: badges changed/added (Socket, DeepWiki with Release on same line, X rename, OpenSSF Scorecard after FOSSA), and a documentation note under Batch Check clarifying result order is not guaranteed and recommending correlationId. No code, API, or exported entity changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
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 #260 +/- ##
=======================================
Coverage 88.16% 88.16%
=======================================
Files 23 23
Lines 1217 1217
Branches 216 216
=======================================
Hits 1073 1073
Misses 86 86
Partials 58 58 ☔ 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: 0
🧹 Nitpick comments (6)
README.md (6)
4-5: Badges: OK; avoid data-URI logo for DeepWiki (may not render on GitHub/npm).Inline base64 logos can be blocked by CSP and bloat the line. Prefer a Shields text badge (or a hosted logo) to ensure consistent rendering.
Preview the README on GitHub and npmjs to confirm the DeepWiki badge renders. If not, apply:
-[ ](https://deepwiki.com/openfga/js-sdk)[](https://github.com/openfga/js-sdk/releases) +[](https://deepwiki.com/openfga/js-sdk)[](https://github.com/openfga/js-sdk/releases)
7-7: OpenSSF Scorecard: pin to default branch for stability.Add branch to both badge and viewer to avoid ambiguous/default-branch drift.
-[](https://securityscorecards.dev/viewer/?uri=github.com/openfga/js-sdk) +[](https://securityscorecards.dev/viewer/?uri=github.com/openfga/js-sdk&branch=main)
9-9: Use the X logo to match the platform rename.Minor visual polish; current badge uses the Twitter logo while linking to x.com.
-[](https://x.com/openfga) +[](https://x.com/openfga)
66-66: Rename “Twitter” to “X” for consistency with the badge/link.Keep branding consistent across README.
-- [Twitter](https://twitter.com/openfga) +- [X](https://x.com/openfga)
453-454: Good note; clarify correlationId uniqueness.Nice addition. Suggest clarifying that correlationId should be unique per check item to avoid collisions.
-> **Note**: The order of `batchCheck` results is not guaranteed to match the order of the checks provided. Use `correlationId` to pair responses with requests. +> **Note**: The order of `batchCheck` results is not guaranteed to match the order of the checks provided. Use a unique `correlationId` per check to pair responses with requests.
472-474: Typo: “correliationId” → “correlationId”.Fix the misspelling in the example comment.
- // optional correliationId to associate request and response. One will be generated + // optional correlationId to associate request and response. One will be generated
aaguiarz
changed the title
3 participants
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit